home *** CD-ROM | disk | FTP | other *** search
/ BBS in a Box 11 / AMUG BBS in a Box Volume XI (April 1994) (MacWizards).iso / Files / System7 tools / Frontier / Scripting Tools.sit / Scripting Tools / StuffIt & Frontier / DocServer Source Text next >
Encoding:
Text File  |  1992-11-18  |  99.2 KB  |  1,979 lines  |  [TEXT/DOCS]
  1.  
  2. Verb    StuffIt.archive.getMaxCount
  3. Syntax    StuffIt.archive.getMaxCount ()
  4. Parameters    None
  5. Action    Gets the maximum number of archives which StuffIt can have open
  6. Returns    The number of archives which StuffIt can have open
  7. Examples    StuffIt.archive.getMaxCount ()
  8.     »8 (The maximum number of archives which StuffIt can have open with its default memory partition)
  9. See Also    StuffIt.archive.getOpenCount
  10.  
  11. Verb    StuffIt.archive.getOpenCount
  12. Syntax    StuffIt.archive.getOpenCount ()
  13. Parameters    None
  14. Action    Gets the number of open archives.
  15. Returns    The number of archives which are currently open
  16. Examples    StuffIt.archive.getOpenCount ()
  17.     »1 (The number of archives which I currently have open)
  18. See Also    StuffIt.archive.getMaxCount
  19.  
  20. Verb    StuffIt.archive.getPath
  21. Syntax    StuffIt.archive.getPath (index)
  22. Parameters    index: the number of the archive you wish to get information for. The frontmost archive is 0, and all other archives are numbered sequentially from the front
  23. Action    Gets the full pathname of the archive you specify
  24. Returns    The full pathname of the archive specified by index
  25. Examples    StuffIt.archive.getPath (0)
  26.     »"My HD:My Folder:My Archive" (The pathname of the frontmost archive)
  27.  
  28. Verb    StuffIt.bringToFront
  29. Syntax    StuffIt.bringToFront ()
  30. Parameters    None
  31. Action    Brings StuffIt to the front, making it the active application.
  32. Returns    True if the event was successfully sent
  33. Examples    StuffIt.bringToFront ()
  34.     »true (and StuffIt is now the frontmost application)
  35.  
  36. Verb    StuffIt.clear
  37. Syntax    StuffIt.clear ()
  38. Parameters    None
  39. Action    Removes the currently selected item(s) from the frontmost archive
  40. Just like choosing "Clear" from StuffIt's Edit Menu
  41. Returns    true if no error occured while clearing the selected item(s)
  42. Examples    StuffIt.clear ()
  43.     »true
  44. See Also    StuffIt.copy
  45. StuffIt.paste
  46.  
  47. Verb    StuffIt.closeAll
  48. Syntax    StuffIt.closeAll ()
  49. Parameters    None
  50. Action    Closes every open archive
  51. Returns    True if successful, false if no windows were open
  52. Examples    StuffIt.closeAll ()
  53.     »true (There was at least one open archive to close)
  54.  
  55. Verb    StuffIt.closeArchive
  56. Syntax    StuffIt.closeArchive (path)
  57. Parameters    path: the full pathname of the archive you wish to close
  58. Action    Closes the specified archive
  59. Returns    0 if there was no error
  60. 1 if the archive you specify was not open
  61. Examples    StuffIt.closeArchive ("My HD:My Folder:My Archive")
  62.     »0 (Archive was closed)
  63. See Also    openArchive
  64. closeAll
  65.  
  66. Verb    StuffIt.comment.delete
  67. Syntax    StuffIt.comment.delete ()
  68. Parameters    None
  69. Action    Deletes the comment attached to the frontmost archive
  70. Returns    True if the comment was deleted
  71. Examples    StuffIt.comment.delete ()
  72.     »true (comment was deleted)
  73. See Also    comment.get
  74. comment.set
  75. Notes    This verb will return true even if no comment was attached to the archive.
  76.  
  77. Verb    StuffIt.comment.get
  78. Syntax    StuffIt.comment.get ()
  79. Parameters    None
  80. Action    Gets the comment attached to the frontmost archive window
  81. Returns    The comment
  82. Examples    StuffIt.comment.get ()
  83.     »"Check out the 'Cool Things' Folder!" (the comment attached to the frontmost archive
  84. See Also    comment.delete
  85. comment.set
  86.  
  87. Verb    StuffIt.comment.set
  88. Syntax    StuffIt.comment.set (comment)
  89. Parameters    comment: the comment you would like to attach to the frontmost archive
  90. Action    Attaches the comment you specify to the frontmost archive
  91. Returns    True if the comment was successfully added
  92. Examples    StuffIt.comment.set ("Check out the 'Cool Things' Folder!")
  93.     » true (the comment was attached to the frontmost archive)
  94. See Also    comment.delete
  95. comment.get
  96. Notes    Setting the comment will overwrite any existing comment. You may wish to get the comment first, and then set it only if it's empty
  97.  
  98. Verb    StuffIt.convertArchive
  99. Syntax    StuffIt.convertArchive (path)
  100. Parameters    path: the pathname of the archive you wish to convert
  101. Action    StuffIt will attempt to convert the archive from 1.5.1 -> 3.0
  102. Returns    true if the archive was successfully converted
  103. Examples    StuffIt.convertArchive ("My HD:My Folder:Old StuffIt File")
  104.     » true (converts "Old StuffIt File")
  105. See Also    StuffIt.newArchive
  106. StuffIt.closeArchive
  107.  
  108. Verb    StuffIt.copy
  109. Syntax    StuffIt.copy ()
  110. Parameters    None
  111. Action    Copies the currently selected item(s) from the frontmost archive to the clipboard
  112.     this also includes a textual list of file/folder names
  113. Just like choosing "Copy" from StuffIt's Edit Menu
  114. Returns    true if no error occured while copying the selected item(s)
  115. Examples    StuffIt.copy ()
  116.     »true
  117. See Also    StuffIt.clear
  118. StuffIt.paste
  119.  
  120. Verb    StuffIt.copyItem
  121. Syntax    StuffIt.copyItem (srcPath, srcID, destPath, destID)
  122. Parameters    srcPath: the pathname of the archive you wish to copy from
  123. srcID: the offset of the item you wish to copy 
  124. destPath: the pathname of the archive you wish to copy to
  125. destID: the offset of the item where you wish to copy it to.  This MUST be either 0 or a folder ID.
  126. Action    StuffIt will copy the specified item from one archive to another, or from one place in an archive to another.
  127. Returns    0 if successful in copying the item
  128. -1 for no such archive
  129. -3 not folder/archive or encrypted folder
  130. -4 copying to non-root of 1.5.1 archive.
  131. -6 root was specified as source
  132. 15 some items skipped because of copying/moving dlx => 1.5.1 or encrypted
  133. Examples    StuffIt.copyItem ("My HD:My Folder:Old StuffIt File", StuffIt.getFirstItem(), "My HD:My Folder:New StuffIt File", 0)
  134.     » true (copies the first item of "Old StuffIt File" to the root of "New StuffIt File")
  135. See Also    StuffIt.moveItem
  136.  
  137. Verb    StuffIt.deleteItem
  138. Syntax    StuffIt.deleteItem(ID)
  139. Parameters    ID: the offset of the item info within the archive. 0 is the archive itself, and you can determine all subsequent children by using getItemChild and getNextItem.
  140. Action    Deletes the specified iem, without a warning dialog box
  141. Returns    0 if there was no error
  142. -1 if no archive is open
  143. -8 if the archive is read-only
  144. Examples    StuffIt.deleteItem (StuffIt.getFirstItem())
  145.     » 0 (deleted the first item in the archive)
  146. See Also    StuffIt.selection.delete
  147.  
  148. Verb    StuffIt.doScript
  149. Syntax    StuffIt.doScript (script)
  150. Parameters    script: either the text of the script you wish to execute, or a filename that points to a saved script
  151. Action    Executes the script you specify
  152. Returns    True if the script was executed
  153. Examples    StuffIt.doScript ("My HD:My Folder:My Script")
  154.     » true (the script was run)
  155.  
  156. Verb    StuffIt.encryptItem
  157. Syntax    StuffIt.encryptItem (path)
  158. Parameters    path: the pathname of the file or folder you'd like to stuff & encrypt into the current archive
  159. Action    Takes the folder/file you specify and adds it to the current level of the frontmost archive as encrypted.
  160. Returns    0 if there was no error
  161. -1 if no archive is currently open
  162. -7 if there are already too many items in the archive
  163. -8 if the frontmost archive is read-only
  164. Examples    StuffIt.encryptItem ("My HD:My Folder:My File")
  165.     »0 (My File was added to the current level of the archive)
  166. See Also    StuffIt.password.isSet
  167. StuffIt.password.set
  168. StuffIt.stuffItem
  169.  
  170. Verb    StuffIt.getArchiveView
  171. Syntax    StuffIt.getArchiveView (path)
  172. Parameters    path: the pathname of the archive whose view you want to get
  173. Action    Returns the name of the view used to show the contents of the archive
  174. Returns    the name of the view currently being used for this archive
  175. "" if there is an error
  176. Examples    StuffIt.getArchiveView ("My HD:My Folder:Old StuffIt File")
  177.     » "by Order" (converts "Old StuffIt File")
  178. See Also    StuffIt.setArchiveView
  179.  
  180. Verb    StuffIt.getCurrentArchivePath
  181. Syntax    StuffIt.getCurrentArchivePath ()
  182. Parameters    None
  183. Action    Gets the full pathname of the frontmost archive
  184. Returns    The full pathname of the frontmost archive, or -1 if no archive is open.
  185. Examples    StuffIt.getCurrentArchivePath ()
  186.     » My HD:My Folder:My Archive (the pathname of the frontmost archive)
  187. See Also    StuffIt.archive.getPath
  188. StuffIt.setCurrentArchive
  189.  
  190. Verb    StuffIt.getCurrentFolder
  191. Syntax    StuffIt.getCurrentFolder()
  192. Parameters    None
  193. Action    Gets the offset number of the current folder.
  194. Returns    The offset number for the current folder
  195. -1 if no archive is open
  196. -4 if the frontmost archive is a 1.5.1 archive (which this doesn't work for)
  197. Examples    StuffIt.getCurrentFolder ()
  198.     » 0 (we're at the top level of the archive)
  199. See Also    StuffIt.openFolder
  200.  
  201. Verb    StuffIt.getFirstItem
  202. Syntax    StuffIt.getFirstItem()
  203. Parameters    None
  204. Action    Gets the offset number of the first item within the current folder.
  205. Returns    The offset number for the first item in the current folder
  206. -1 if no archive is open
  207. -4 if the frontmost archive is a 1.5.1 archive (which this doesn't work for)
  208. 0 if there are no entries in this folder
  209. Examples    StuffIt.getFirstItem()
  210.     » 22 (the offset of the first item within the archive)
  211. See Also    StuffIt.getNextItem
  212. StuffIt.getPreviousItem
  213.  
  214. Verb    StuffIt.getItemChild
  215. Syntax    StuffIt.getItemChild (ID)
  216. Parameters    ID: the offset of the item info within the archive. 0 is the archive itself, and you can determine all subsequent children by using getItemChild and getNextItem.
  217. Action    Gets the offset number of the first item within the folder you specify.
  218. Returns    The offset number for the first item in the specified folder
  219. -1 if no archive is open
  220. -2 if the offset you specify is not an acceptable range
  221. -3 if the item at the offset is not a folder or an archive
  222. -4 if the frontmost archive is a 1.5.1 archive (which this doesn't work for)
  223. 0 if there are no children of this item
  224. Any other negative number if the item you specify does not exist
  225. Examples    StuffIt.getItemChild (0)
  226.     » 22 (the offset of the first item within the archive)
  227. See Also    StuffIt.getItemParent
  228. StuffIt.getFirstItem
  229. StuffIt.getNextItem
  230. StuffIt.getPreviousItem
  231. StuffIt.getItemCount
  232.  
  233. Verb    StuffIt.getItemCompressedSize
  234. Syntax    StuffIt.getItemCompressedSize(ID)
  235. Parameters    ID: the offset of the item info within the archive. 0 is the root, and you can determine all subsequent children by using getItemChild and getNextItem
  236. Action    Gets the full size (compressed) of the item you specify with offset
  237. Returns    The compressed size of the file, folder, or archive in bytes
  238. -1 if no archive is open
  239. -2 if the offset you specify is not an acceptable range
  240. -5 if the item at the offset is the end of a folder
  241. Any other negative number if the item you specify does not exist
  242. Examples    StuffIt.getItemCompressedSize (StuffIt.getFirstItem())
  243.     » 26345 (the full, uncompressed size of the first item)
  244. See Also    StuffIt.getItemSize
  245.  
  246. Verb    StuffIt.getItemCount
  247. Syntax    StuffIt.getItemCount (ID)
  248. Parameters    ID: the offset of the folder info within the archive. 0 is the root, and you can determine all subsequent children by using getItemChild and getNextItem
  249. Action    Gets the number of items in the item at the offset you specify
  250. Returns    The number of children in the specified item
  251. -1 if no archive is open
  252. -2 if the offset you specify is not an acceptable range
  253. -3 if the item at the offset is not a folder or an archive
  254. -4 if the frontmost archive is a 1.5.1 archive (which this doesn't work for)
  255. 0 if there are no children of this item
  256. Any other negative number if the item you specify does not exist
  257. Examples    StuffIt.getItemCount (0)
  258.     » 3 (the number of items in the frontmost archive)
  259. See Also    StuffIt.getFirstItem
  260. StuffIt.getNextItem
  261. StuffIt.getPreviousItem
  262. StuffIt.getItemChild
  263.  
  264. Verb    StuffIt.getItemCreated
  265. Syntax    StuffIt.getItemCreated (ID)
  266. Parameters    ID: the offset of the item info within the archive. 0 is the root, and you can determine all subsequent children by using getItemChild and getNextItem
  267. Action    Gets the creation date of the item specified by ID
  268. Returns    The creation date of the specified item
  269. -1 if no archive is open
  270. -2 if the offset you specify is not an acceptable range
  271. Any other negative number if the item you specify does not exist
  272. Examples    StuffIt.getItemCreated (0)
  273.     » 3/21/92 (the date the archive was created)
  274. See Also    StuffIt.getItemModified
  275.  
  276. Verb    StuffIt.getItemCreator
  277. Syntax    StuffIt.getItemCreator (ID)
  278. Parameters    ID: the offset of the item info within the archive. 0 is the root, and you can determine all subsequent children by using getItemChild and getNextItem
  279. Action    Gets the four-letter signature of the application which created this document
  280. Returns    The creator signature of the application which created the document
  281. -1 if no archive is open
  282. -2 if the offset you specify is not an acceptable range
  283. -5 if the item you specify is a folder or end of folder
  284. Any other negative number if the item you specify does not exist
  285. Examples    StuffIt.getItemCreator (0)
  286.     » "SIT!" (since the archive itself is at offset 0, the application which created it is StuffIt)
  287. See Also    StuffIt.getItemType
  288. StuffIt.getItemKind
  289.  
  290. Verb    StuffIt.getItemID
  291. Syntax    StuffIt.getItemID (index)
  292. Parameters    index: the index of the file at the current level whose ID (offset) you wish to get
  293. Action    Returns the offset of the item at the specified indexed location in the current folder
  294. Returns    offset of the item
  295. -1 if no archive is open
  296. -2 if the index you specify is not an acceptable range
  297. Any other negative number if the item you specify does not exist
  298. Examples    StuffIt.getItemID (1)
  299.     » 22 (the offset of the first item)
  300. See Also    StuffIt.getFirstItem
  301. StuffIt.getNextItem
  302. StuffIt.getPreviousItem
  303. StuffIt.getItemChild
  304.  
  305. Verb    StuffIt.getItemKind
  306. Syntax    StuffIt.getItemKind (ID)
  307. Parameters    ID: the offset of the item info within the archive. 0 is the root, and you can determine all subsequent children by using getItemChild and getNextItem
  308. Action    Returns a description about what kind of item is at the offset you specify
  309. Returns    archive, folder, file, or end-of-folder
  310. -1 if no archive is open
  311. -2 if the offset you specify is not an acceptable range
  312. Any other negative number if the item you specify does not exist
  313. Examples    StuffIt.getItemKind (0)
  314.     » archive (the item 0 represents the archive itself)
  315. See Also    StuffIt.getItemType
  316. StuffIt.getItemCreator
  317.  
  318. Verb    StuffIt.getItemLabel
  319. Syntax    StuffIt.getItemLabel (ID)
  320. Parameters    ID: the offset of the item info within the archive. 0 is the root, and you can determine all subsequent children by using getItemChild and getNextItem
  321. Action    Returns the name of the label of the item which is at the offset you specify
  322. Returns    the name of the label (or None)
  323. -1 if no archive is open
  324. -2 if the offset you specify is not an acceptable range
  325. Any other negative number if the item you specify does not exist
  326. Examples    StuffIt.getItemLabel (StuffIt.getFirstItem())
  327.     » None (the label of the first item in the archive)
  328. See Also    StuffIt.setItemLabel
  329.  
  330. Verb    StuffIt.getItemModified
  331. Syntax    StuffIt.getItemModified (ID)
  332. Parameters    ID: the offset of the item info within the archive. 0 is the root, and you can determine all subsequent children by using getItemChild and getNextItem
  333. Action    Gets the modified date of the item at offset ID
  334. Returns    The modified date of the file, folder, or archive
  335. -1 if no archive is open
  336. -2 if the offset you specify is not an acceptable range
  337. -5 if the item at the offset is the end of a folder
  338. Any other negative number if the item you specify does not exist
  339. Examples    StuffIt.getItemModified (0)
  340.     » 3/21/92 (the last date that this archive was modified)
  341. See Also    StuffIt.getItemCreated
  342.  
  343. Verb    StuffIt.getItemName
  344. Syntax    StuffIt.getItemName (ID)
  345. Parameters    ID: the offset of the item info within the archive. 0 is the root, and you can determine all subsequent children by using getItemChild and getNextItem
  346. Action    Gets the name of the item at offset ID
  347. Returns    The name of the file, folder, or archive
  348. -1 if no archive is open
  349. -2 if the offset you specify is not an acceptable range
  350. -5 if the item at the offset is the end of a folder
  351. Any other negative number if the item you specify does not exist
  352. Examples    StuffIt.getItemName (StuffIt.getFirstItem())
  353.     » Things to look at (the name of the first item)
  354. See Also    StuffIt.getItemType
  355. StuffIt.getItemCreator
  356. StuffIt.getItemKind
  357.  
  358. Verb    StuffIt.getItemParent
  359. Syntax    StuffIt.getItemParent(ID)
  360. Parameters    ID: the offset of the item info within the archive. 
  361. Action    Gets the offset number of the folder containing the item you specify.
  362. Returns    The offset number for the folder containing the specified item
  363. -1 if no archive is open
  364. -2 if the offset you specify is not an acceptable range
  365. -4 if the frontmost archive is a 1.5.1 archive (which this doesn't work for)
  366. Any other negative number if the item you specify does not exist
  367. Examples    StuffIt.getItemParent (StuffIt.getFirstItem())
  368.     » 0 (the archive)
  369. See Also    StuffIt.getItemChild
  370. StuffIt.getFirstItem
  371. StuffIt.getNextItem
  372. StuffIt.getPreviousItem
  373. StuffIt.getItemCount
  374.  
  375. Verb    StuffIt.getItemSize
  376. Syntax    StuffIt.getItemSize(ID)
  377. Parameters    ID: the offset of the item info within the archive. 0 is the root, and you can determine all subsequent children by using getItemChild and getNextItem
  378. Action    Gets the full size (uncompressed) of the item you specify with offset
  379. Returns    The size of the file, folder, or archive in bytes
  380. -1 if no archive is open
  381. -2 if the offset you specify is not an acceptable range
  382. -5 if the item at the offset is the end of a folder
  383. Any other negative number if the item you specify does not exist
  384. Examples    StuffIt.getItemSize (StuffIt.getFirstItem())
  385.     » 26345 (the full, uncompressed size of the first item)
  386. See Also    StuffIt.getItemCompressedSize
  387.  
  388. Verb    StuffIt.getItemType
  389. Syntax    StuffIt.getItemType(ID)
  390. Parameters    ID: the offset of the item info within the archive. 0 is the root, and you can determine all subsequent children by using getItemChild and getNextItem
  391. Action    Gets the four-letter string which indicates the file type
  392. Returns    The type of the file, folder, or archive
  393. -1 if no archive is open
  394. -2 if the offset you specify is not an acceptable range
  395. -5 if the item at the offset is the end of a folder
  396. Any other negative number if the item you specify does not exist
  397. Examples    StuffIt.getItemType (StuffIt.getFirstItem())
  398.     » TEXT (the first item is a text document)
  399. See Also    StuffIt.getItemCreator
  400. StuffIt.getItemKind
  401.  
  402. Verb    StuffIt.getNextItem
  403. Syntax    StuffIt.getNextItem(ID)
  404. Parameters    ID: the offset of the item info within the archive. 0 is the root, and you can determine all subsequent children by using getItemChild and getNextItem
  405. Action    Gets the offset of the item that comes next in the archive, relative to the item you specify
  406. Returns    The offset of the next file, folder, or end-of-folder
  407. -1 if no archive is open
  408. -2 if the offset you specify is not an acceptable range
  409. -6 if the root of the archive (0) was specified
  410. 0 if there is no next item
  411. Any other negative number if the item you specify does not exist
  412. Examples    StuffIt.getNextItem (StuffIt.getFirstItem())
  413.     » 134 (the second item (next after first) can be found at offset 134)
  414. See Also    StuffIt.getItemChild
  415. StuffIt.getItemParent
  416. StuffIt.getPreviousItem
  417. StuffIt.getFirstItem
  418.  
  419. Verb    StuffIt.getPreviousItem
  420. Syntax    StuffIt.getPreviousItem(ID)
  421. Parameters    ID: the offset of the item info within the archive. 0 is the root, and you can determine all subsequent children by using getItemChild and getNextItem
  422. Action    Gets the offset of the item that comes before it in the archive, relative to the item you specify
  423. Returns    The offset of the previous file, folder, or end-of-folder
  424. -1 if no archive is open
  425. -2 if the offset you specify is not an acceptable range
  426. -6 if the root of the archive (0) was specified
  427. 0 if there is no previous item
  428. Any other negative number if the item you specify does not exist
  429. Examples    StuffIt.getPreviousItem (StuffIt.getNextItem(StuffIt.getFirstItem()))
  430.     » 22 (the first item (previous of next of first))
  431. See Also    StuffIt.getItemChild
  432. StuffIt.getItemParent
  433. StuffIt.getNextItem
  434. StuffIt.getFirstItem
  435.  
  436. Verb    StuffIt.getVersion
  437. Syntax    StuffIt.getVersion ()
  438. Parameters    None
  439. Action    Gets the version information of the currenly running copy of StuffIt.
  440. Returns    The version of StuffIt you are running
  441. false (and an error) if StuffIt is not running
  442. Examples    StuffIt.getVersion ()
  443.     » StuffIt Deluxe™ 3.0 (the version of StuffIt which is running)
  444.  
  445. Verb    StuffIt.isFolder
  446. Syntax    StuffIt.isFolder (ID)
  447. Parameters    ID: the offset of the item info within the archive. 0 is the root, and you can determine all subsequent children by using getItemChild and getNextItem
  448. Action    Determines if the item at the offset you specify is a folder
  449. Returns    true if the item you specify is a folder, false if it is not
  450. Examples    StuffIt.isFolder (22)
  451.     » true (the item at offset 22 is a folder)
  452. See Also    getItemKind
  453.  
  454. Verb    StuffIt.isRunning
  455. Syntax    StuffIt.isRunning ()
  456. Parameters    None
  457. Action    Determines if StuffIt is running
  458. Returns    true if StuffIt is running, false if it is not
  459. Examples    StuffIt.isRunning ()
  460.     » true (Of course you always keep StuffIt running!)
  461. Notes    Since this is based on the Frontier verb sys.appIsRunning, and StuffIt's creator signature has not changed at all, this will return true even if an older version is running.
  462. As a result, you should get the version of the program to make sure that it really is 3.0 or greater so that you can send it AppleEvents.
  463. See Also    StuffIt.getVersion
  464. StuffIt.launch
  465.  
  466. Verb    StuffIt.launch
  467. Syntax    StuffIt.launch ()
  468. Parameters    None
  469. Action    Opens StuffIt on your hard drive
  470. Returns    true if StuffIt was launched, false if it was not
  471. Examples    StuffIt.launch ()
  472.     » true (StuffIt was launched)
  473. Notes    The pathname of your copy of StuffIt is stored in StuffIt.appInfo.path. If you have moved StuffIt, or you are using this verb for the first time, you will get a dialog asking you to find your copy of StuffIt.
  474. Be sure to choose StuffIt 3.0, since the script only checks the creator of the file you select, and therefore any version of StuffIt would satisfy this dialog. This could be a problem if you want to send AppleEvents.
  475. See Also    StuffIt.getVersion
  476. StuffIt.isRunning
  477.  
  478. Verb    StuffIt.matchCriteria.addCommentBeginsWith
  479. Syntax    StuffIt.matchCriteria.addCommentBeginsWith (text)
  480. Parameters    text: the text you wish to use as the parameter for this Add Match command
  481. Action    Establishes, as an Add Match criteria, to add all files whose comments begin with the text you specify
  482. Returns    true if the event was successfully sent
  483. -1 if no archive is open
  484. Examples    StuffIt.matchCriteria.addCommentBeginsWith ("Cool")
  485. » true (the criterium was added to the Add Match qualifiers)
  486. Notes    As with StuffIt, you cannot specify more than one kind of qualifier for each Add Match parameter. Thus, you cannot add all files whose comments  begin with "Cool" and end with "Deal".
  487. If you do make a new qualifier (e.g., a new qualifier for addComment), it will overwrite the old one.
  488.  
  489. See Also    StuffIt.matchcriteria.addCommentContains
  490. StuffIt.matchcriteria.addCommentEndsWith
  491. StuffIt.matchcriteria.addCommentIs
  492. StuffIt.matchcriteria.addCommentIsNot
  493. StuffIt.matchcriteria.addCommentNotBeginsWith
  494. StuffIt.matchcriteria.addCommentNotContains
  495. StuffIt.matchcriteria.addCommentNotEndsWith
  496.  
  497. Verb    StuffIt.matchCriteria.addCommentContains
  498. Syntax    StuffIt.matchCriteria.addCommentContains (text)
  499. Parameters    text: the text you wish to use as the parameter for this Add Match command
  500. Action    Establishes, as an Add Match criteria, to add all files whose comments contain the text you specify
  501. Returns    true if the event was successfully sent
  502. -1 if no archive is open
  503. Examples    StuffIt.matchCriteria.addCommentContains ("Cool")
  504. » true (the criterium was added to the Add Match qualifiers)
  505. Notes    As in StuffIt, you cannot specify more than one kind of qualifier for each Add Match parameter. Thus, you cannot add all files whose comments contain with "Cool" and end with "Deal".
  506. If you do make a new qualifier (e.g., a new qualifier for addComment), it will overwrite the old one.
  507.  
  508. See Also    StuffIt.matchcriteria.addCommentBeginsWith
  509. StuffIt.matchcriteria.addCommentEndsWith
  510. StuffIt.matchcriteria.addCommentIs
  511. StuffIt.matchcriteria.addCommentIsNot
  512. StuffIt.matchcriteria.addCommentNotBeginsWith
  513. StuffIt.matchcriteria.addCommentNotContains
  514. StuffIt.matchcriteria.addCommentNotEndsWith
  515.  
  516. Verb    StuffIt.matchCriteria.addCommentEndsWith
  517. Syntax    StuffIt.matchCriteria.addCommentEndsWith (text)
  518. Parameters    text: the text you wish to use as the parameter for this Add Match command
  519. Action    Establishes, as an Add Match criteria, to add all files whose comments end with the text you specify
  520. Returns    true if the event was successfully sent
  521. -1 if no archive is open
  522. Examples    StuffIt.matchCriteria.addCommentEndsWith ("Deal")
  523. » true (the criterium was added to the Add Match qualifiers)
  524. Notes    As in StuffIt, you cannot specify more than one kind of qualifier for each Add Match parameter. Thus, you cannot add all files whose comments contain with "Cool" and end with "Deal".
  525. If you do make a new qualifier (e.g., a new qualifier for addComment), it will overwrite the old one.
  526.  
  527. See Also    StuffIt.matchcriteria.addCommentBeginsWith
  528. StuffIt.matchcriteria.addCommentContains
  529. StuffIt.matchcriteria.addCommentIs
  530. StuffIt.matchcriteria.addCommentIsNot
  531. StuffIt.matchcriteria.addCommentNotBeginsWith
  532. StuffIt.matchcriteria.addCommentNotContains
  533. StuffIt.matchcriteria.addCommentNotEndsWith
  534.  
  535. Verb    StuffIt.matchCriteria.addCommentIs
  536. Syntax    StuffIt.matchCriteria.addCommentIs (text)
  537. Parameters    text: the text you wish to use as the parameter for this Add Match command
  538. Action    Establishes, as an Add Match criteria, to add all files whose comments are exactly the text you specify
  539. Returns    true if the event was successfully sent
  540. -1 if no archive is open
  541. Examples    StuffIt.matchCriteria.addCommentIs ("Cool Deal")
  542. » true (the criterium was added to the Add Match qualifiers)
  543. Notes    As in StuffIt, you cannot specify more than one kind of qualifier for each Add Match parameter. Thus, you cannot add all files whose comments contain with "Cool" and end with "Deal".
  544. If you do make a new qualifier (e.g., a new qualifier for addComment), it will overwrite the old one.
  545.  
  546. See Also    StuffIt.matchcriteria.addCommentBeginsWith
  547. StuffIt.matchcriteria.addCommentContains
  548. StuffIt.matchcriteria.addCommentEndsWith
  549. StuffIt.matchcriteria.addCommentIsNot
  550. StuffIt.matchcriteria.addCommentNotBeginsWith
  551. StuffIt.matchcriteria.addCommentNotContains
  552. StuffIt.matchcriteria.addCommentNotEndsWith
  553.  
  554. Verb    StuffIt.matchCriteria.addCommentIsNot
  555. Syntax    StuffIt.matchCriteria.addCommentIsNot (text)
  556. Parameters    text: the text you wish to use as the parameter for this Add Match command
  557. Action    Establishes, as an Add Match criteria, to add all files whose comments are anything but the text you specify
  558. Returns    true if the event was successfully sent
  559. -1 if no archive is open
  560. Examples    StuffIt.matchCriteria.addCommentIsNot ("Cool Deal")
  561. » true (the criterium was added to the Add Match qualifiers)
  562. Notes    As in StuffIt, you cannot specify more than one kind of qualifier for each Add Match parameter. Thus, you cannot add all files whose comments contain with "Cool" and end with "Deal".
  563. If you do make a new qualifier (e.g., a new qualifier for addComment), it will overwrite the old one.
  564.  
  565. See Also    StuffIt.matchcriteria.addCommentBeginsWith
  566. StuffIt.matchcriteria.addCommentContains
  567. StuffIt.matchcriteria.addCommentEndsWith
  568. StuffIt.matchcriteria.addCommentIs
  569. StuffIt.matchcriteria.addCommentNotBeginsWith
  570. StuffIt.matchcriteria.addCommentNotContains
  571. StuffIt.matchcriteria.addCommentNotEndsWith
  572.  
  573. Verb    StuffIt.matchCriteria.addCommentNotBeginsWith
  574. Syntax    StuffIt.matchCriteria.addCommentNotBeginsWith (text)
  575. Parameters    text: the text you wish to use as the parameter for this Add Match command
  576. Action    Establishes, as an Add Match criteria, to add all files whose comments do not begin with the text you specify
  577. Returns    true if the event was successfully sent
  578. -1 if no archive is open
  579. Examples    StuffIt.matchCriteria.addCommentNotBeginsWith ("Cool")
  580. » true (the criterium was added to the Add Match qualifiers)
  581. Notes    As in StuffIt, you cannot specify more than one kind of qualifier for each Add Match parameter. Thus, you cannot add all files whose comments contain with "Cool" and end with "Deal".
  582. If you do make a new qualifier (e.g., a new qualifier for addComment), it will overwrite the old one.
  583.  
  584. See Also    StuffIt.matchcriteria.addCommentBeginsWith
  585. StuffIt.matchcriteria.addCommentContains
  586. StuffIt.matchcriteria.addCommentEndsWith
  587. StuffIt.matchcriteria.addCommentIs
  588. StuffIt.matchcriteria.addCommentIsNot
  589. StuffIt.matchcriteria.addCommentNotContains
  590. StuffIt.matchcriteria.addCommentNotEndsWith
  591.  
  592. Verb    StuffIt.matchCriteria.addCommentNotContains
  593. Syntax    StuffIt.matchCriteria.addCommentNotContains (text)
  594. Parameters    text: the text you wish to use as the parameter for this Add Match command
  595. Action    Establishes, as an Add Match criteria, to add all files whose comments do not contain the text you specify
  596. Returns    true if the event was successfully sent
  597. -1 if no archive is open
  598. Examples    StuffIt.matchCriteria.addCommentNotContains ("Cool")
  599. » true (the criterium was added to the Add Match qualifiers)
  600. Notes    As in StuffIt, you cannot specify more than one kind of qualifier for each Add Match parameter. Thus, you cannot add all files whose comments contain with "Cool" and end with "Deal".
  601. If you do make a new qualifier (e.g., a new qualifier for addComment), it will overwrite the old one.
  602.  
  603. See Also    StuffIt.matchcriteria.addCommentBeginsWith
  604. StuffIt.matchcriteria.addCommentContains
  605. StuffIt.matchcriteria.addCommentEndsWith
  606. StuffIt.matchcriteria.addCommentIs
  607. StuffIt.matchcriteria.addCommentIsNot
  608. StuffIt.matchcriteria.addCommentNotBeginsWith
  609. StuffIt.matchcriteria.addCommentNotEndsWith
  610.  
  611. Verb    StuffIt.matchCriteria.addCommentNotEndsWith
  612. Syntax    StuffIt.matchCriteria.addCommentNotEndsWith (text)
  613. Parameters    text: the text you wish to use as the parameter for this Add Match command
  614. Action    Establishes, as an Add Match criteria, to add all files whose comments do not end with the text you specify
  615. Returns    true if the event was successfully sent
  616. -1 if no archive is open
  617. Examples    StuffIt.matchCriteria.addCommentNotEndsWith ("Cool")
  618. » true (the criterium was added to the Add Match qualifiers)
  619. Notes    As in StuffIt, you cannot specify more than one kind of qualifier for each Add Match parameter. Thus, you cannot add all files whose comments contain with "Cool" and end with "Deal".
  620. If you do make a new qualifier (e.g., a new qualifier for addComment), it will overwrite the old one.
  621.  
  622. See Also    StuffIt.matchcriteria.addCommentBeginsWith
  623. StuffIt.matchcriteria.addCommentContains
  624. StuffIt.matchcriteria.addCommentEndsWith
  625. StuffIt.matchcriteria.addCommentIs
  626. StuffIt.matchcriteria.addCommentIsNot
  627. StuffIt.matchcriteria.addCommentNotBeginsWith
  628. StuffIt.matchcriteria.addCommentNotContains
  629.  
  630. Verb    StuffIt.matchCriteria.addCreatedAfter
  631. Syntax    StuffIt.matchCriteria.addCreatedAfter (date)
  632. Parameters    date: the date you wish to use as the parameter for this Add Match command
  633. Note: you can use the following key phrases instead of a specific date
  634. today, yesterday, this week, this month, this year, last week, last month, last year, last archive change
  635. Action    Establishes, as an Add Match criteria, to add all files which were created after the date you specify
  636. Returns    true if the event was successfully sent
  637. -1 if no archive is open
  638. Examples    StuffIt.matchCriteria.addCreatedAfter ("this week")
  639. » true (the criterium was added to the Add Match qualifiers)
  640. Notes    As in StuffIt, you cannot specify more than one kind of qualifier for each Add Match parameter. Thus, you cannot add all files made after today and all files made since the last archive change.
  641. If you do make a new qualifier (e.g., a new qualifier for addComment), it will overwrite the old one.
  642.  
  643. See Also    StuffIt.matchcriteria.addCreatedBefore
  644. StuffIt.matchcriteria.addCreatedBetween
  645. StuffIt.matchcriteria.addCreatedNotBetween
  646. StuffIt.matchcriteria.addCreatedOn
  647. StuffIt.matchcriteria.addCreatedNotOn
  648.  
  649. Verb    StuffIt.matchCriteria.addCreatedBefore
  650. Syntax    StuffIt.matchCriteria.addCreatedBefore (date)
  651. Parameters    date: the date you wish to use as the parameter for this Add Match command
  652. Note: you can use the following key phrases instead of a specific date
  653. today, yesterday, this week, this month, this year, last week, last month, last year, last archive change
  654. Action    Establishes, as an Add Match criteria, to add all files which were created before the date you specify
  655. Returns    true if the event was successfully sent
  656. -1 if no archive is open
  657. Examples    StuffIt.matchCriteria.addCreatedBefore ("this week")
  658. » true (the criterium was added to the Add Match qualifiers)
  659. Notes    As in StuffIt, you cannot specify more than one kind of qualifier for each Add Match parameter. Thus, you cannot add all files made after today and all files made since the last archive change.
  660. If you do make a new qualifier (e.g., a new qualifier for addComment), it will overwrite the old one.
  661.  
  662. See Also    StuffIt.matchcriteria.addCreatedAfter
  663. StuffIt.matchcriteria.addCreatedBetween
  664. StuffIt.matchcriteria.addCreatedNotBetween
  665. StuffIt.matchcriteria.addCreatedOn
  666. StuffIt.matchcriteria.addCreatedNotOn
  667.  
  668. Verb    StuffIt.matchCriteria.addCreatedBetween
  669. Syntax    StuffIt.matchCriteria.addCreatedBetween (date1, date2)
  670. Parameters    date1, date2: the dates you wish to use as the parameter for this Add Match command
  671. Note: you can use the following key phrases instead of a specific date
  672. today, yesterday, this week, this month, this year, last week, last month, last year, last archive change
  673. Action    Establishes, as an Add Match criteria, to add all files which were created between the dates you specify
  674. Returns    true if the event was successfully sent
  675. -1 if no archive is open
  676. Examples    StuffIt.matchCriteria.addCreatedBetween ("last week","today")
  677. » true (the criterium was added to the Add Match qualifiers)
  678. Notes    As in StuffIt, you cannot specify more than one kind of qualifier for each Add Match parameter. Thus, you cannot add all files made after today and all files made since the last archive change.
  679. If you do make a new qualifier (e.g., a new qualifier for addComment), it will overwrite the old one.
  680. See Also    StuffIt.matchcriteria.addCreatedAfter
  681. StuffIt.matchcriteria.addCreatedBefore
  682. StuffIt.matchcriteria.addCreatedNotBetween
  683. StuffIt.matchcriteria.addCreatedOn
  684. StuffIt.matchcriteria.addCreatedNotOn
  685.  
  686. Verb    StuffIt.matchCriteria.addCreatedNotBetween
  687. Syntax    StuffIt.matchCriteria.addCreatedNotBetween (date1, date2)
  688. Parameters    date1, date2: the dates you wish to use as the parameter for this Add Match command
  689. Note: you can use the following key phrases instead of a specific date
  690. today, yesterday, this week, this month, this year, last week, last month, last year, last archive change
  691. Action    Establishes, as an Add Match criteria, to add all files which were not created between the dates you specify
  692. Returns    true if the event was successfully sent
  693. -1 if no archive is open
  694. Examples    StuffIt.matchCriteria.addCreatedNotBetween ("last week","today")
  695. » true (the criterium was added to the Add Match qualifiers)
  696. Notes    As in StuffIt, you cannot specify more than one kind of qualifier for each Add Match parameter. Thus, you cannot add all files made after today and all files made since the last archive change.
  697. If you do make a new qualifier (e.g., a new qualifier for addComment), it will overwrite the old one.
  698.  
  699. See Also    StuffIt.matchcriteria.addCreatedAfter
  700. StuffIt.matchcriteria.addCreatedBefore
  701. StuffIt.matchcriteria.addCreatedBetween
  702. StuffIt.matchcriteria.addCreatedOn
  703. StuffIt.matchcriteria.addCreatedNotOn
  704.  
  705. Verb    StuffIt.matchCriteria.addCreatedNotOn
  706. Syntax    StuffIt.matchCriteria.addCreatedNotOn (date)
  707. Parameters    date: the date you wish to use as the parameter for this Add Match command
  708. Note: you can use the following key phrases instead of a specific date
  709. today, yesterday, this week, this month, this year, last week, last month, last year, last archive change
  710. Action    Establishes, as an Add Match criteria, to add all files which were not created on the date you specify
  711. Returns    true if the event was successfully sent
  712. -1 if no archive is open
  713. Examples    StuffIt.matchCriteria.addCreatedNotOn ("this week")
  714. » true (the criterium was added to the Add Match qualifiers)
  715. Notes    As in StuffIt, you cannot specify more than one kind of qualifier for each Add Match parameter. Thus, you cannot add all files made after today and all files made since the last archive change.
  716. If you do make a new qualifier (e.g., a new qualifier for addComment), it will overwrite the old one.
  717.  
  718. See Also    StuffIt.matchcriteria.addCreatedAfter
  719. StuffIt.matchcriteria.addCreatedBetween
  720. StuffIt.matchcriteria.addCreatedNotBetween
  721. StuffIt.matchcriteria.addCreatedBefore
  722. StuffIt.matchcriteria.addCreatedOn
  723.  
  724. Verb    StuffIt.matchCriteria.addCreatedOn
  725. Syntax    StuffIt.matchCriteria.addCreatedOn (date)
  726. Parameters    date: the date you wish to use as the parameter for this Add Match command
  727. Note: you can use the following key phrases instead of a specific date
  728. today, yesterday, this week, this month, this year, last week, last month, last year, last archive change
  729. Action    Establishes, as an Add Match criteria, to add all files which were created on the date you specify
  730. Returns    true if the event was successfully sent
  731. -1 if no archive is open
  732. Examples    StuffIt.matchCriteria.addCreatedOn ("yesterday")
  733. » true (the criterium was added to the Add Match qualifiers)
  734. Notes    As in StuffIt, you cannot specify more than one kind of qualifier for each Add Match parameter. Thus, you cannot add all files made after today and all files made since the last archive change.
  735. If you do make a new qualifier (e.g., a new qualifier for addComment), it will overwrite the old one.
  736.  
  737. See Also    StuffIt.matchcriteria.addCreatedAfter
  738. StuffIt.matchcriteria.addCreatedBetween
  739. StuffIt.matchcriteria.addCreatedNotBetween
  740. StuffIt.matchcriteria.addCreatedBefore
  741. StuffIt.matchcriteria.addCreatedNotOn
  742.  
  743. Verb    StuffIt.matchCriteria.addKindBeginsWith
  744. Syntax    StuffIt.matchCriteria.addKindBeginsWith (type)
  745. Parameters    type: the type of file (e.g., alias) you wish to use as the parameter for this Add Match command
  746. Action    Establishes, as an Add Match criteria, to add all files whose kinds begin with the type you specify
  747. Returns    true if the event was successfully sent
  748. -1 if no archive is open
  749. Examples    StuffIt.matchCriteria.addKindBeginsWith ("app")
  750. » true (the criterium was added to the Add Match qualifiers)
  751. Notes    As in StuffIt, you cannot specify more than one kind of qualifier for each Add Match parameter. Thus, you cannot add all files whose kinds  begin with "app" and end with "nt".
  752. If you do make a new qualifier (e.g., a new qualifier for addComment), it will overwrite the old one.
  753.  
  754. See Also    StuffIt.matchcriteria.addKindContains
  755. StuffIt.matchcriteria.addKindEndsWith
  756. StuffIt.matchcriteria.addKindIs
  757. StuffIt.matchcriteria.addKindIsNot
  758. StuffIt.matchcriteria.addKindNotBeginsWith
  759. StuffIt.matchcriteria.addKindNotContains
  760. StuffIt.matchcriteria.addKindNotEndsWith
  761.  
  762. Verb    StuffIt.matchCriteria.addKindContains
  763. Syntax    StuffIt.matchCriteria.addKindContains (type)
  764. Parameters    type: the type of file (e.g., alias) you wish to use as the parameter for this Add Match command
  765. Action    Establishes, as an Add Match criteria, to add all files whose kinds contain the type you specify
  766. Returns    true if the event was successfully sent
  767. -1 if no archive is open
  768. Examples    StuffIt.matchCriteria.addKindContains ("app")
  769. » true (the criterium was added to the Add Match qualifiers)
  770. Notes    As in StuffIt, you cannot specify more than one kind of qualifier for each Add Match parameter. Thus, you cannot add all files whose kinds  begin with "app" and end with "nt".
  771. If you do make a new qualifier (e.g., a new qualifier for addComment), it will overwrite the old one.
  772.  
  773. See Also    StuffIt.matchcriteria.addKindBeginsWith
  774. StuffIt.matchcriteria.addKindEndsWith
  775. StuffIt.matchcriteria.addKindIs
  776. StuffIt.matchcriteria.addKindIsNot
  777. StuffIt.matchcriteria.addKindNotBeginsWith
  778. StuffIt.matchcriteria.addKindNotContains
  779. StuffIt.matchcriteria.addKindNotEndsWith
  780.  
  781. Verb    StuffIt.matchCriteria.addKindEndsWith
  782. Syntax    StuffIt.matchCriteria.addKindEndsWith (type)
  783. Parameters    type: the type of file (e.g., alias) you wish to use as the parameter for this Add Match command
  784. Action    Establishes, as an Add Match criteria, to add all files whose kinds end with the type you specify
  785. Returns    true if the event was successfully sent
  786. -1 if no archive is open
  787. Examples    StuffIt.matchCriteria.addKindEndsWith ("app")
  788. » true (the criterium was added to the Add Match qualifiers)
  789. Notes    As in StuffIt, you cannot specify more than one kind of qualifier for each Add Match parameter. Thus, you cannot add all files whose kinds  begin with "app" and end with "nt".
  790. If you do make a new qualifier (e.g., a new qualifier for addComment), it will overwrite the old one.
  791.  
  792. See Also    StuffIt.matchcriteria.addKindBeginsWith
  793. StuffIt.matchcriteria.addKindContains
  794. StuffIt.matchcriteria.addKindIs
  795. StuffIt.matchcriteria.addKindIsNot
  796. StuffIt.matchcriteria.addKindNotBeginsWith
  797. StuffIt.matchcriteria.addKindNotContains
  798. StuffIt.matchcriteria.addKindNotEndsWith
  799.  
  800. Verb    StuffIt.matchCriteria.addKindIs
  801. Syntax    StuffIt.matchCriteria.addKindIs (type)
  802. Parameters    type: the type of file (e.g., alias) you wish to use as the parameter for this Add Match command
  803. Action    Establishes, as an Add Match criteria, to add all files whose kinds are exactly the type you specify
  804. Returns    true if the event was successfully sent
  805. -1 if no archive is open
  806. Examples    StuffIt.matchCriteria.addKindIs ("app")
  807. » true (the criterium was added to the Add Match qualifiers)
  808. Notes    As in StuffIt, you cannot specify more than one kind of qualifier for each Add Match parameter. Thus, you cannot add all files whose kinds  begin with "app" and end with "nt".
  809. If you do make a new qualifier (e.g., a new qualifier for addComment), it will overwrite the old one.
  810.  
  811. See Also    StuffIt.matchcriteria.addKindBeginsWith
  812. StuffIt.matchcriteria.addKindContains
  813. StuffIt.matchcriteria.addKindEndsWith
  814. StuffIt.matchcriteria.addKindIsNot
  815. StuffIt.matchcriteria.addKindNotBeginsWith
  816. StuffIt.matchcriteria.addKindNotContains
  817. StuffIt.matchcriteria.addKindNotEndsWith
  818.  
  819. Verb    StuffIt.matchCriteria.addKindIsNot
  820. Syntax    StuffIt.matchCriteria.addKindIsNot (type)
  821. Parameters    type: the type of file (e.g., alias) you wish to use as the parameter for this Add Match command
  822. Action    Establishes, as an Add Match criteria, to add all files whose kinds are not exactly the type you specify
  823. Returns    true if the event was successfully sent
  824. -1 if no archive is open
  825. Examples    StuffIt.matchCriteria.addKindIsNot ("app")
  826. » true (the criterium was added to the Add Match qualifiers)
  827. Notes    As in StuffIt, you cannot specify more than one kind of qualifier for each Add Match parameter. Thus, you cannot add all files whose kinds  begin with "app" and end with "nt".
  828. If you do make a new qualifier (e.g., a new qualifier for addComment), it will overwrite the old one.
  829.  
  830. See Also    StuffIt.matchcriteria.addKindBeginsWith
  831. StuffIt.matchcriteria.addKindContains
  832. StuffIt.matchcriteria.addKindEndsWith
  833. StuffIt.matchcriteria.addKindIs
  834. StuffIt.matchcriteria.addKindNotBeginsWith
  835. StuffIt.matchcriteria.addKindNotContains
  836. StuffIt.matchcriteria.addKindNotEndsWith
  837.  
  838. Verb    StuffIt.matchCriteria.addKindNotBeginsWith
  839. Syntax    StuffIt.matchCriteria.addKindNotBeginsWith (type)
  840. Parameters    type: the type of file (e.g., alias) you wish to use as the parameter for this Add Match command
  841. Action    Establishes, as an Add Match criteria, to add all files whose kinds do not begin with the type you specify
  842. Returns    true if the event was successfully sent
  843. -1 if no archive is open
  844. Examples    StuffIt.matchCriteria.addKindNotBeginsWith ("app")
  845. » true (the criterium was added to the Add Match qualifiers)
  846. Notes    As in StuffIt, you cannot specify more than one kind of qualifier for each Add Match parameter. Thus, you cannot add all files whose kinds  begin with "app" and end with "nt".
  847. If you do make a new qualifier (e.g., a new qualifier for addComment), it will overwrite the old one.
  848.  
  849. See Also    StuffIt.matchcriteria.addKindBeginsWith
  850. StuffIt.matchcriteria.addKindContains
  851. StuffIt.matchcriteria.addKindEndsWith
  852. StuffIt.matchcriteria.addKindIs
  853. StuffIt.matchcriteria.addKindIsNot
  854. StuffIt.matchcriteria.addKindNotContains
  855. StuffIt.matchcriteria.addKindNotEndsWith
  856.  
  857. Verb    StuffIt.matchCriteria.addKindNotContains
  858. Syntax    StuffIt.matchCriteria.addKindNotContains (type)
  859. Parameters    type: the type of file (e.g., alias) you wish to use as the parameter for this Add Match command
  860. Action    Establishes, as an Add Match criteria, to add all files whose kinds do not contain the type you specify
  861. Returns    true if the event was successfully sent
  862. -1 if no archive is open
  863. Examples    StuffIt.matchCriteria.addKindNotContains ("app")
  864. » true (the criterium was added to the Add Match qualifiers)
  865. Notes    As in StuffIt, you cannot specify more than one kind of qualifier for each Add Match parameter. Thus, you cannot add all files whose kinds  begin with "app" and end with "nt".
  866. If you do make a new qualifier (e.g., a new qualifier for addComment), it will overwrite the old one.
  867.  
  868. See Also    StuffIt.matchcriteria.addKindBeginsWith
  869. StuffIt.matchcriteria.addKindContains
  870. StuffIt.matchcriteria.addKindEndsWith
  871. StuffIt.matchcriteria.addKindIs
  872. StuffIt.matchcriteria.addKindIsNot
  873. StuffIt.matchcriteria.addKindNotBeginsWith
  874. StuffIt.matchcriteria.addKindNotEndsWith
  875.  
  876. Verb    StuffIt.matchCriteria.addKindNotEndsWith
  877. Syntax    StuffIt.matchCriteria.addKindNotEndsWith (type)
  878. Parameters    type: the type of file (e.g., alias) you wish to use as the parameter for this Add Match command
  879. Action    Establishes, as an Add Match criteria, to add all files whose kinds do not end with the type you specify
  880. Returns    true if the event was successfully sent
  881. -1 if no archive is open
  882. Examples    StuffIt.matchCriteria.addKindNotEndsWith ("app")
  883. » true (the criterium was added to the Add Match qualifiers)
  884. Notes    As in StuffIt, you cannot specify more than one kind of qualifier for each Add Match parameter. Thus, you cannot add all files whose kinds  begin with "app" and end with "nt".
  885. If you do make a new qualifier (e.g., a new qualifier for addComment), it will overwrite the old one.
  886.  
  887. See Also    StuffIt.matchcriteria.addKindBeginsWith
  888. StuffIt.matchcriteria.addKindContains
  889. StuffIt.matchcriteria.addKindEndsWith
  890. StuffIt.matchcriteria.addKindIs
  891. StuffIt.matchcriteria.addKindIsNot
  892. StuffIt.matchcriteria.addKindNotBeginsWith
  893. StuffIt.matchcriteria.addKindNotContains
  894.  
  895. Verb    StuffIt.matchCriteria.addLabelIs
  896. Syntax    StuffIt.matchCriteria.addLabelIs (label)
  897. Parameters    label: the label you wish to use as a qualifier for this Add Match command
  898. Action    Establishes, as an Add Match criteria, to add all files whose label is the one you specify
  899. Returns    true if the event was successfully sent
  900. -1 if no archive is open
  901. Examples    StuffIt.matchCriteria.addLabelIs ("Don't Backup")
  902. » true (the criterium was added to the Add Match qualifiers)
  903. Notes    As in StuffIt, you cannot specify more than one kind of qualifier for each Add Match parameter. Thus, you cannot add all files whose labels are "Don't backup" and all files whose label is "System software"
  904. If you do make a new qualifier (e.g., a new qualifier for addComment), it will overwrite the old one.
  905.  
  906. See Also    StuffIt.matchcriteria.addLabelIsNot
  907.  
  908. Verb    StuffIt.matchCriteria.addLabelIsNot
  909. Syntax    StuffIt.matchCriteria.addLabelIsNot (label)
  910. Parameters    label: the label you wish to use as a qualifier for this Add Match command
  911. Action    Establishes, as an Add Match criteria, to add all files whose label is not the one you specify
  912. Returns    true if the event was successfully sent
  913. -1 if no archive is open
  914. Examples    StuffIt.matchCriteria.addLabelIsNot ("System Software")
  915. » true (the criterium was added to the Add Match qualifiers)
  916. Notes    As in StuffIt, you cannot specify more than one kind of qualifier for each Add Match parameter. Thus, you cannot add all files whose kinds  begin with "app" and end with "nt".
  917. If you do make a new qualifier (e.g., a new qualifier for addComment), it will overwrite the old one.
  918.  
  919. See Also    StuffIt.matchcriteria.addLabelIs
  920.  
  921. Verb    StuffIt.matchCriteria.addModifiedAfter
  922. Syntax    StuffIt.matchCriteria.addModifiedAfter (date)
  923. Parameters    date: the date you wish to use as the parameter for this Add Match command
  924. Note: you can use the following key phrases instead of a specific date
  925. today, yesterday, this week, this month, this year, last week, last month, last year, last archive change
  926. Action    Establishes, as an Add Match criteria, to add all files which were modified after the date you specify
  927. Returns    true if the event was successfully sent
  928. -1 if no archive is open
  929. Examples    StuffIt.matchCriteria.addModifiedAfter ("this week")
  930. » true (the criterium was added to the Add Match qualifiers)
  931. Notes    As in StuffIt, you cannot specify more than one kind of qualifier for each Add Match parameter. Thus, you cannot add all files modified after today and all files modified since the last archive change.
  932. If you do make a new qualifier (e.g., a new qualifier for addComment), it will overwrite the old one.
  933.  
  934. See Also    StuffIt.matchcriteria.addModifiedBefore
  935. StuffIt.matchcriteria.addModifiedBetween
  936. StuffIt.matchcriteria.addModifiedNotBetween
  937. StuffIt.matchcriteria.addModifiedOn
  938. StuffIt.matchcriteria.addModifiedNotOn
  939. StuffIt.matchcriteria.addModifiedSinceLastChange
  940.  
  941. Verb    StuffIt.matchCriteria.addModifiedBefore
  942. Syntax    StuffIt.matchCriteria.addModifiedBefore (date)
  943. Parameters    date: the date you wish to use as the parameter for this Add Match command
  944. Note: you can use the following key phrases instead of a specific date
  945. today, yesterday, this week, this month, this year, last week, last month, last year, last archive change
  946. Action    Establishes, as an Add Match criteria, to add all files which were modified before the date you specify
  947. Returns    true if the event was successfully sent
  948. -1 if no archive is open
  949. Examples    StuffIt.matchCriteria.addModifiedBefore ("this week")
  950. » true (the criterium was added to the Add Match qualifiers)
  951. Notes    As in StuffIt, you cannot specify more than one kind of qualifier for each Add Match parameter. Thus, you cannot add all files modified after today and all files modified since the last archive change.
  952. If you do make a new qualifier (e.g., a new qualifier for addComment), it will overwrite the old one.
  953.  
  954. See Also    StuffIt.matchcriteria.addModifiedAfter
  955. StuffIt.matchcriteria.addModifiedBetween
  956. StuffIt.matchcriteria.addModifiedNotBetween
  957. StuffIt.matchcriteria.addModifiedOn
  958. StuffIt.matchcriteria.addModifiedNotOn
  959. StuffIt.matchcriteria.addModifiedSinceLastChange
  960.  
  961. Verb    StuffIt.matchCriteria.addModifiedBetween
  962. Syntax    StuffIt.matchCriteria.addModifiedBetween (date1, date2)
  963. Parameters    date1, date2: the dates you wish to use as the parameter for this Add Match command
  964. Note: you can use the following key phrases instead of a specific date
  965. today, yesterday, this week, this month, this year, last week, last month, last year, last archive change
  966. Action    Establishes, as an Add Match criteria, to add all files which were modified between the dates you specify
  967. Returns    true if the event was successfully sent
  968. -1 if no archive is open
  969. Examples    StuffIt.matchCriteria.addModifiedBetween ("this week", "last year")
  970. » true (the criterium was added to the Add Match qualifiers)
  971. Notes    As in StuffIt, you cannot specify more than one kind of qualifier for each Add Match parameter. Thus, you cannot add all files modified after today and all files modified since the last archive change.
  972. If you do make a new qualifier (e.g., a new qualifier for addComment), it will overwrite the old one.
  973.  
  974. See Also    StuffIt.matchcriteria.addModifiedAfter
  975. StuffIt.matchcriteria.addModifiedBefore
  976. StuffIt.matchcriteria.addModifiedNotBetween
  977. StuffIt.matchcriteria.addModifiedOn
  978. StuffIt.matchcriteria.addModifiedNotOn
  979. StuffIt.matchcriteria.addModifiedSinceLastChange
  980.  
  981. Verb    StuffIt.matchCriteria.addModifiedNotBetween
  982. Syntax    StuffIt.matchCriteria.addModifiedNotBetween (date1, date2)
  983. Parameters    date1, date2: the dates you wish to use as the parameter for this Add Match command
  984. Note: you can use the following key phrases instead of a specific date
  985. today, yesterday, this week, this month, this year, last week, last month, last year, last archive change
  986. Action    Establishes, as an Add Match criteria, to add all files which were not modified between the dates you specify
  987. Returns    true if the event was successfully sent
  988. -1 if no archive is open
  989. Examples    StuffIt.matchCriteria.addModifiedNotBetween ("this week", "last year")
  990. » true (the criterium was added to the Add Match qualifiers)
  991. Notes    As in StuffIt, you cannot specify more than one kind of qualifier for each Add Match parameter. Thus, you cannot add all files modified after today and all files modified since the last archive change.
  992. If you do make a new qualifier (e.g., a new qualifier for addComment), it will overwrite the old one.
  993.  
  994. See Also    StuffIt.matchcriteria.addModifiedAfter
  995. StuffIt.matchcriteria.addModifiedBefore
  996. StuffIt.matchcriteria.addModifiedBetween
  997. StuffIt.matchcriteria.addModifiedOn
  998. StuffIt.matchcriteria.addModifiedNotOn
  999. StuffIt.matchcriteria.addModifiedSinceLastChange
  1000.  
  1001. Verb    StuffIt.matchCriteria.addModifiedNotOn
  1002. Syntax    StuffIt.matchCriteria.addModifiedNotOn (date)
  1003. Parameters    date: the date you wish to use as the parameter for this Add Match command
  1004. Note: you can use the following key phrases instead of a specific date
  1005. today, yesterday, this week, this month, this year, last week, last month, last year, last archive change
  1006. Action    Establishes, as an Add Match criteria, to add all files which were not modified on the date you specify
  1007. Returns    true if the event was successfully sent
  1008. -1 if no archive is open
  1009. Examples    StuffIt.matchCriteria.addModifiedNotOn ("this week")
  1010. » true (the criterium was added to the Add Match qualifiers)
  1011. Notes    As in StuffIt, you cannot specify more than one kind of qualifier for each Add Match parameter. Thus, you cannot add all files modified after today and all files modified since the last archive change.
  1012. If you do make a new qualifier (e.g., a new qualifier for addComment), it will overwrite the old one.
  1013.  
  1014. See Also    StuffIt.matchcriteria.addModifiedAfter
  1015. StuffIt.matchcriteria.addModifiedBetween
  1016. StuffIt.matchcriteria.addModifiedNotBetween
  1017. StuffIt.matchcriteria.addModifiedBefore
  1018. StuffIt.matchcriteria.addModifiedOn
  1019. StuffIt.matchcriteria.addModifiedSinceLastChange
  1020.  
  1021. Verb    StuffIt.matchCriteria.addModifiedOn
  1022. Syntax    StuffIt.matchCriteria.addModifiedOn (date)
  1023. Parameters    date: the date you wish to use as the parameter for this Add Match command
  1024. Note: you can use the following key phrases instead of a specific date
  1025. today, yesterday, this week, this month, this year, last week, last month, last year, last archive change
  1026. Action    Establishes, as an Add Match criteria, to add all files which were modified on the date you specify
  1027. Returns    true if the event was successfully sent
  1028. -1 if no archive is open
  1029. Examples    StuffIt.matchCriteria.addModifiedOn ("this week")
  1030. » true (the criterium was added to the Add Match qualifiers)
  1031. Notes    As in StuffIt, you cannot specify more than one kind of qualifier for each Add Match parameter. Thus, you cannot add all files modified after today and all files modified since the last archive change.
  1032. If you do make a new qualifier (e.g., a new qualifier for addComment), it will overwrite the old one.
  1033.  
  1034. See Also    StuffIt.matchcriteria.addModifiedAfter
  1035. StuffIt.matchcriteria.addModifiedBetween
  1036. StuffIt.matchcriteria.addModifiedNotBetween
  1037. StuffIt.matchcriteria.addModifiedBefore
  1038. StuffIt.matchcriteria.addModifiedNotOn
  1039. StuffIt.matchcriteria.addModifiedSinceLastChange
  1040.  
  1041. Verb    StuffIt.matchCriteria.addModifiedSinceLastChange
  1042. Syntax    StuffIt.matchCriteria.addModifiedSinceLastChange ()
  1043. Parameters    None
  1044. Action    Establishes, as an Add Match criteria, to add all files which were modified since the modified date of the archive
  1045. Returns    true if the event was successfully sent
  1046. -1 if no archive is open
  1047. Examples    StuffIt.matchCriteria.addModifiedSinceLastChange ()
  1048. » true (the criterium was added to the Add Match qualifiers)
  1049. Notes    As in StuffIt, you cannot specify more than one kind of qualifier for each Add Match parameter. Thus, you cannot add all files modified after today and all files modified since the last archive change.
  1050. If you do make a new qualifier (e.g., a new qualifier for addComment), it will overwrite the old one.
  1051.  
  1052. See Also    StuffIt.matchcriteria.addModifiedAfter
  1053. StuffIt.matchcriteria.addModifiedBetween
  1054. StuffIt.matchcriteria.addModifiedNotBetween
  1055. StuffIt.matchcriteria.addModifiedBefore
  1056. StuffIt.matchcriteria.addModifiedOn
  1057. StuffIt.matchcriteria.addModifiedNotOn
  1058.  
  1059. Verb    StuffIt.matchCriteria.addNameBeginsWith
  1060. Syntax    StuffIt.matchCriteria.addNameBeginsWith (text)
  1061. Parameters    text: the text you wish to use as a parameter for this Add Match command
  1062. Action    Establishes, as an Add Match criteria, to add all files whose names begin with the text you specify
  1063. Returns    true if the event was successfully sent
  1064. -1 if no archive is open
  1065. Examples    StuffIt.matchCriteria.addNameBeginsWith ("app")
  1066. » true (the criterium was added to the Add Match qualifiers)
  1067. Notes    As in StuffIt, you cannot specify more than one kind of qualifier for each Add Match parameter. Thus, you cannot add all files whose names  begin with "app" and whose names end with "per".
  1068. If you do make a new qualifier (e.g., a new qualifier for addComment), it will overwrite the old one.
  1069.  
  1070. See Also    StuffIt.matchcriteria.addNameContains
  1071. StuffIt.matchcriteria.addNameEndsWith
  1072. StuffIt.matchcriteria.addNameIs
  1073. StuffIt.matchcriteria.addNameIsNot
  1074. StuffIt.matchcriteria.addNameNotBeginsWith
  1075. StuffIt.matchcriteria.addNameNotContains
  1076. StuffIt.matchcriteria.addNameNotEndsWith
  1077.  
  1078. Verb    StuffIt.matchCriteria.addNameContains
  1079. Syntax    StuffIt.matchCriteria.addNameContains (text)
  1080. Parameters    text: the text you wish to use as a parameter for this Add Match command
  1081. Action    Establishes, as an Add Match criteria, to add all files whose names contain the text you specify
  1082. Returns    true if the event was successfully sent
  1083. -1 if no archive is open
  1084. Examples    StuffIt.matchCriteria.addNameContains ("app")
  1085. » true (the criterium was added to the Add Match qualifiers)
  1086. Notes    As in StuffIt, you cannot specify more than one kind of qualifier for each Add Match parameter. Thus, you cannot add all files whose names  begin with "app" and whose names end with "per".
  1087. If you do make a new qualifier (e.g., a new qualifier for addComment), it will overwrite the old one.
  1088.  
  1089. See Also    StuffIt.matchcriteria.addNameBeginsWith
  1090. StuffIt.matchcriteria.addNameEndsWith
  1091. StuffIt.matchcriteria.addNameIs
  1092. StuffIt.matchcriteria.addNameIsNot
  1093. StuffIt.matchcriteria.addNameNotBeginsWith
  1094. StuffIt.matchcriteria.addNameNotContains
  1095. StuffIt.matchcriteria.addNameNotEndsWith
  1096.  
  1097. Verb    StuffIt.matchCriteria.addNameEndsWith
  1098. Syntax    StuffIt.matchCriteria.addNameEndsWith (text)
  1099. Parameters    text: the text you wish to use as a parameter for this Add Match command
  1100. Action    Establishes, as an Add Match criteria, to add all files whose names end with the text you specify
  1101. Returns    true if the event was successfully sent
  1102. -1 if no archive is open
  1103. Examples    StuffIt.matchCriteria.addNameEndsWith ("app")
  1104. » true (the criterium was added to the Add Match qualifiers)
  1105. Notes    As in StuffIt, you cannot specify more than one kind of qualifier for each Add Match parameter. Thus, you cannot add all files whose names  begin with "app" and whose names end with "per".
  1106. If you do make a new qualifier (e.g., a new qualifier for addComment), it will overwrite the old one.
  1107.  
  1108. See Also    StuffIt.matchcriteria.addNameBeginsWith
  1109. StuffIt.matchcriteria.addNameContains
  1110. StuffIt.matchcriteria.addNameIs
  1111. StuffIt.matchcriteria.addNameIsNot
  1112. StuffIt.matchcriteria.addNameNotBeginsWith
  1113. StuffIt.matchcriteria.addNameNotContains
  1114. StuffIt.matchcriteria.addNameNotEndsWith
  1115.  
  1116. Verb    StuffIt.matchCriteria.addNameIs
  1117. Syntax    StuffIt.matchCriteria.addNameIs (text)
  1118. Parameters    text: the text you wish to use as a parameter for this Add Match command
  1119. Action    Establishes, as an Add Match criteria, to add all files whose names are exactly the text you specify
  1120. Returns    true if the event was successfully sent
  1121. -1 if no archive is open
  1122. Examples    StuffIt.matchCriteria.addNameIs ("app")
  1123. » true (the criterium was added to the Add Match qualifiers)
  1124. Notes    As in StuffIt, you cannot specify more than one kind of qualifier for each Add Match parameter. Thus, you cannot add all files whose names  begin with "app" and whose names end with "per".
  1125. If you do make a new qualifier (e.g., a new qualifier for addComment), it will overwrite the old one.
  1126.  
  1127. See Also    StuffIt.matchcriteria.addNameBeginsWith
  1128. StuffIt.matchcriteria.addNameContains
  1129. StuffIt.matchcriteria.addNameEndsWith
  1130. StuffIt.matchcriteria.addNameIsNot
  1131. StuffIt.matchcriteria.addNameNotBeginsWith
  1132. StuffIt.matchcriteria.addNameNotContains
  1133. StuffIt.matchcriteria.addNameNotEndsWith
  1134.  
  1135. Verb    StuffIt.matchCriteria.addNameIsNot
  1136. Syntax    StuffIt.matchCriteria.addNameIsNot (text)
  1137. Parameters    text: the text you wish to use as a parameter for this Add Match command
  1138. Action    Establishes, as an Add Match criteria, to add all files whose names are not exactly the text you specify
  1139. Returns    true if the event was successfully sent
  1140. -1 if no archive is open
  1141. Examples    StuffIt.matchCriteria.addNameIsNot ("app")
  1142. » true (the criterium was added to the Add Match qualifiers)
  1143. Notes    As in StuffIt, you cannot specify more than one kind of qualifier for each Add Match parameter. Thus, you cannot add all files whose names  begin with "app" and whose names end with "per".
  1144. If you do make a new qualifier (e.g., a new qualifier for addComment), it will overwrite the old one.
  1145.  
  1146. See Also    StuffIt.matchcriteria.addNameBeginsWith
  1147. StuffIt.matchcriteria.addNameContains
  1148. StuffIt.matchcriteria.addNameEndsWith
  1149. StuffIt.matchcriteria.addNameIs
  1150. StuffIt.matchcriteria.addNameNotBeginsWith
  1151. StuffIt.matchcriteria.addNameNotContains
  1152. StuffIt.matchcriteria.addNameNotEndsWith
  1153.  
  1154. Verb    StuffIt.matchCriteria.addNameNotBeginsWith
  1155. Syntax    StuffIt.matchCriteria.addNameNotBeginsWith (text)
  1156. Parameters    text: the text you wish to use as a parameter for this Add Match command
  1157. Action    Establishes, as an Add Match criteria, to add all files whose names do not begin with the text you specify
  1158. Returns    true if the event was successfully sent
  1159. -1 if no archive is open
  1160. Examples    StuffIt.matchCriteria.addNameNotBeginsWith ("app")
  1161. » true (the criterium was added to the Add Match qualifiers)
  1162. Notes    As in StuffIt, you cannot specify more than one kind of qualifier for each Add Match parameter. Thus, you cannot add all files whose names  begin with "app" and whose names end with "per".
  1163. If you do make a new qualifier (e.g., a new qualifier for addComment), it will overwrite the old one.
  1164.  
  1165. See Also    StuffIt.matchcriteria.addNameBeginsWith
  1166. StuffIt.matchcriteria.addNameContains
  1167. StuffIt.matchcriteria.addNameEndsWith
  1168. StuffIt.matchcriteria.addNameIs
  1169. StuffIt.matchcriteria.addNameIsNot
  1170. StuffIt.matchcriteria.addNameNotContains
  1171. StuffIt.matchcriteria.addNameNotEndsWith
  1172.  
  1173. Verb    StuffIt.matchCriteria.addNameNotContains
  1174. Syntax    StuffIt.matchCriteria.addNameNotContains (text)
  1175. Parameters    text: the text you wish to use as a parameter for this Add Match command
  1176. Action    Establishes, as an Add Match criteria, to add all files whose names do not contain the text you specify
  1177. Returns    true if the event was successfully sent
  1178. -1 if no archive is open
  1179. Examples    StuffIt.matchCriteria.addNameNotContains ("app")
  1180. » true (the criterium was added to the Add Match qualifiers)
  1181. Notes    As in StuffIt, you cannot specify more than one kind of qualifier for each Add Match parameter. Thus, you cannot add all files whose names  begin with "app" and whose names end with "per".
  1182. If you do make a new qualifier (e.g., a new qualifier for addComment), it will overwrite the old one.
  1183.  
  1184. See Also    StuffIt.matchcriteria.addNameBeginsWith
  1185. StuffIt.matchcriteria.addNameContains
  1186. StuffIt.matchcriteria.addNameEndsWith
  1187. StuffIt.matchcriteria.addNameIs
  1188. StuffIt.matchcriteria.addNameIsNot
  1189. StuffIt.matchcriteria.addNameNotBeginsWith
  1190. StuffIt.matchcriteria.addNameNotEndsWith
  1191.  
  1192. Verb    StuffIt.matchCriteria.addNameNotEndsWith
  1193. Syntax    StuffIt.matchCriteria.addNameNotEndsWith (text)
  1194. Parameters    text: the text you wish to use as a parameter for this Add Match command
  1195. Action    Establishes, as an Add Match criteria, to add all files whose names do not end with the text you specify
  1196. Returns    true if the event was successfully sent
  1197. -1 if no archive is open
  1198. Examples    StuffIt.matchCriteria.addNameNotEndsWith ("app")
  1199. » true (the criterium was added to the Add Match qualifiers)
  1200. Notes    As in StuffIt, you cannot specify more than one kind of qualifier for each Add Match parameter. Thus, you cannot add all files whose names  begin with "app" and whose names end with "per".
  1201. If you do make a new qualifier (e.g., a new qualifier for addComment), it will overwrite the old one.
  1202.  
  1203. See Also    StuffIt.matchcriteria.addNameBeginsWith
  1204. StuffIt.matchcriteria.addNameContains
  1205. StuffIt.matchcriteria.addNameEndsWith
  1206. StuffIt.matchcriteria.addNameIs
  1207. StuffIt.matchcriteria.addNameIsNot
  1208. StuffIt.matchcriteria.addNameNotBeginsWith
  1209. StuffIt.matchcriteria.addNameNotContains
  1210.  
  1211. Verb    StuffIt.matchCriteria.addSizeIs
  1212. Syntax    StuffIt.matchCriteria.addSizeIs (number)
  1213. Parameters    number: the size (in K) you wish to use as a parameter for this Add Match command.
  1214. Action    Establishes, as an Add Match criteria, to add all files which are the same number of kilobytes as number
  1215. Returns    true if the event was successfully sent
  1216. -1 if no archive is open
  1217. Examples    StuffIt.matchCriteria.addSizeIs ("123456")
  1218. » true (the criterium was added to the Add Match qualifiers)
  1219. Notes    As in StuffIt, you cannot specify more than one kind of qualifier for each Add Match parameter.  Size is unique in that you can often get around this restriction by using a different size addMatch.
  1220. If you do make a new qualifier (e.g., a new qualifier for addComment), it will overwrite the old one.
  1221.  
  1222. See Also    StuffIt.matchcriteria.addSizeIsBetween
  1223. StuffIt.matchcriteria.addSizeIsNotBetween
  1224. StuffIt.matchcriteria.addSizeIsGreaterThan
  1225. StuffIt.matchcriteria.addSizeIsLessThan
  1226. StuffIt.matchcriteria.addSizeIsNot
  1227.  
  1228. Verb    StuffIt.matchCriteria.addSizeIsBetween
  1229. Syntax    StuffIt.matchCriteria.addSizeIsBetween (number1,number2)
  1230. Parameters    number1, number2: the sizes (in K) you wish to use as parameters for this Add Match command.
  1231. Action    Establishes, as an Add Match criteria, to add all files which are between the sizes you specify
  1232. Returns    true if the event was successfully sent
  1233. -1 if no archive is open
  1234. Examples    StuffIt.matchCriteria.addSizeIsBetween ("123456", "345956")
  1235. » true (the criterium was added to the Add Match qualifiers)
  1236. Notes    As in StuffIt, you cannot specify more than one kind of qualifier for each Add Match parameter.  Size is unique in that you can often get around this restriction by using a different size addMatch.
  1237. If you do make a new qualifier (e.g., a new qualifier for addComment), it will overwrite the old one.
  1238. See Also    StuffIt.matchcriteria.addSizeIs
  1239. StuffIt.matchcriteria.addSizeIsNotBetween
  1240. StuffIt.matchcriteria.addSizeIsGreaterThan
  1241. StuffIt.matchcriteria.addSizeIsLessThan
  1242. StuffIt.matchcriteria.addSizeIsNot
  1243.  
  1244. Verb    StuffIt.matchCriteria.addSizeIsGreaterThan
  1245. Syntax    StuffIt.matchCriteria.addSizeIsGreaterThan (number)
  1246. Parameters    number: the size (in K) you wish to use as a parameter for this Add Match command.
  1247. Action    Establishes, as an Add Match criteria, to add all files which are bigger than the size you specify
  1248. Returns    true if the event was successfully sent
  1249. -1 if no archive is open
  1250. Examples    StuffIt.matchCriteria.addSizeIsGreaterThan ("123456")
  1251. » true (the criterium was added to the Add Match qualifiers)
  1252. Notes    As in StuffIt, you cannot specify more than one kind of qualifier for each Add Match parameter.  Size is unique in that you can often get around this restriction by using a different size addMatch.
  1253. If you do make a new qualifier (e.g., a new qualifier for addComment), it will overwrite the old one.
  1254.  
  1255. See Also    StuffIt.matchcriteria.addSizeIsBetween
  1256. StuffIt.matchcriteria.addSizeIsNotBetween
  1257. StuffIt.matchcriteria.addSizeIs
  1258. StuffIt.matchcriteria.addSizeIsLessThan
  1259. StuffIt.matchcriteria.addSizeIsNot
  1260.  
  1261. Verb    StuffIt.matchCriteria.addSizeIsLessThan
  1262. Syntax    StuffIt.matchCriteria.addSizeIsLessThan (number)
  1263. Parameters    number: the size (in K) you wish to use as a parameter for this Add Match command.
  1264. Action    Establishes, as an Add Match criteria, to add all files which are smaller than the size you specify
  1265. Returns    true if the event was successfully sent
  1266. -1 if no archive is open
  1267. Examples    StuffIt.matchCriteria.addSizeIsLessThan ("123456")
  1268. » true (the criterium was added to the Add Match qualifiers)
  1269. Notes    As in StuffIt, you cannot specify more than one kind of qualifier for each Add Match parameter.  Size is unique in that you can often get around this restriction by using a different size addMatch.
  1270. If you do make a new qualifier (e.g., a new qualifier for addComment), it will overwrite the old one.
  1271.  
  1272. See Also    StuffIt.matchcriteria.addSizeIsBetween
  1273. StuffIt.matchcriteria.addSizeIsNotBetween
  1274. StuffIt.matchcriteria.addSizeIs
  1275. StuffIt.matchcriteria.addSizeIsGreaterThan
  1276. StuffIt.matchcriteria.addSizeIsNot
  1277.  
  1278. Verb    StuffIt.matchCriteria.addSizeIsNot
  1279. Syntax    StuffIt.matchCriteria.addSizeIsNot (number)
  1280. Parameters    number: the size (in K) you wish to use as a parameter for this Add Match command.
  1281. Action    Establishes, as an Add Match criteria, to add all files which are not the size you specify
  1282. Returns    true if the event was successfully sent
  1283. -1 if no archive is open
  1284. Examples    StuffIt.matchCriteria.addSizeIsNot ("123456")
  1285. » true (the criterium was added to the Add Match qualifiers)
  1286. Notes    As in StuffIt, you cannot specify more than one kind of qualifier for each Add Match parameter.  Size is unique in that you can often get around this restriction by using a different size addMatch.
  1287. If you do make a new qualifier (e.g., a new qualifier for addComment), it will overwrite the old one.
  1288.  
  1289. See Also    StuffIt.matchcriteria.addSizeIsBetween
  1290. StuffIt.matchcriteria.addSizeIsNotBetween
  1291. StuffIt.matchcriteria.addSizeIs
  1292. StuffIt.matchcriteria.addSizeIsGreaterThan
  1293. StuffIt.matchcriteria.addSizeIsLessThan
  1294.  
  1295. Verb    StuffIt.matchCriteria.addSizeIsNotBetween
  1296. Syntax    StuffIt.matchCriteria.addSizeIsNotBetween (number1,number2)
  1297. Parameters    number1, number2: the sizes (in K) you wish to use as parameters for this Add Match command.
  1298. Action    Establishes, as an Add Match criteria, to add all files which are not between the sizes you specify
  1299. Returns    true if the event was successfully sent
  1300. -1 if no archive is open
  1301. Examples    StuffIt.matchCriteria.addSizeIsNotBetween ("123456", "345956")
  1302. » true (the criterium was added to the Add Match qualifiers)
  1303. Notes    As in StuffIt, you cannot specify more than one kind of qualifier for each Add Match parameter.  Size is unique in that you can often get around this restriction by using a different size addMatch.
  1304. If you do make a new qualifier (e.g., a new qualifier for addComment), it will overwrite the old one.
  1305.  
  1306. See Also    StuffIt.matchcriteria.addSizeIsBetween
  1307. StuffIt.matchcriteria.addSizeIs
  1308. StuffIt.matchcriteria.addSizeIsGreaterThan
  1309. StuffIt.matchcriteria.addSizeIsLessThan
  1310. StuffIt.matchcriteria.addSizeIsNot
  1311.  
  1312. Verb    StuffIt.matchCriteria.addTypeCreatorIs
  1313. Syntax    StuffIt.matchCriteria.addTypeCreatorIs (type,creator)
  1314. Parameters    type: the four-letter filetype you wish to use as a parameter
  1315. creator: the four-letter application signature you wish to use as a parameter
  1316. Action    Establishes, as an Add Match criteria, to add all files whose types and creators are the ones you specify
  1317. Returns    true if the event was successfully sent
  1318. -1 if no archive is open
  1319. Examples    StuffIt.matchCriteria.addTypeCreatorIs ("ttro","ttxt")
  1320. » true (the criterium was added to the Add Match qualifiers)
  1321. Notes    As in StuffIt, you cannot specify more than one kind of qualifier for each Add Match parameter. Thus, you cannot add all MacWrite II documents and all ResEdit documents
  1322. If you do make a new qualifier (e.g., a new qualifier for addComment), it will overwrite the old one.
  1323.  
  1324. See Also    StuffIt.matchcriteria.addTypeCreatorIsNot
  1325.  
  1326. Verb    StuffIt.matchCriteria.addTypeCreatorIsNot
  1327. Syntax    StuffIt.matchCriteria.addTypeCreatorIsNot (type,creator)
  1328. Parameters    type: the four-letter filetype you wish to use as a parameter
  1329. creator: the four-letter application signature you wish to use as a parameter
  1330. Action    Establishes, as an Add Match criteria, to add all files whose types and creators are not the ones you specify
  1331. Returns    true if the event was successfully sent
  1332. -1 if no archive is open
  1333. Examples    StuffIt.matchCriteria.addTypeCreatorIsNot ("ttro","ttxt")
  1334. » true (the criterium was added to the Add Match qualifiers)
  1335. Notes    As in StuffIt, you cannot specify more than one kind of qualifier for each Add Match parameter. Thus, you cannot add all MacWrite II documents and all ResEdit documents
  1336. If you do make a new qualifier (e.g., a new qualifier for addComment), it will overwrite the old one.
  1337.  
  1338. See Also    StuffIt.matchcriteria.addTypeCreatorIs
  1339.  
  1340. Verb    StuffIt.matchCriteria.clear
  1341. Syntax    StuffIt.matchCriteria.clear ()
  1342. Parameters    None
  1343. Action    Clears the settings for the Add Match, allowing you to begin again
  1344. Returns    true or false, depending on success
  1345. Examples    StuffIt.matchCriteria.clear ()
  1346. »true (Add Match criteria were cleared from memory)
  1347.  
  1348. Verb    StuffIt.moveItem
  1349. Syntax    StuffIt.moveItem (srcPath, srcID, destPath, destID)
  1350. Parameters    srcPath: the pathname of the archive you wish to move from
  1351. srcID: the offset of the item you wish to move 
  1352. destPath: the pathname of the archive you wish to move to
  1353. destID: the offset of the item where you wish to move it to.  This MUST be either 0 or a folder ID.
  1354. Action    StuffIt will moves the specified item from one archive to another, or from one place in an archive to another.
  1355. Returns    0 if successful in copying the item
  1356. -1 for no such archive
  1357. -3 not folder/archive or encrypted folder
  1358. -4 moving to non-root of 1.5.1 archive.
  1359. -6 root was specified as source
  1360. 15 some items skipped because of copying/moving dlx => 1.5.1 or encrypted
  1361. Examples    StuffIt.moveItem ("My HD:My Folder:Old StuffIt File", StuffIt.getFirstItem(), "My HD:My Folder:New StuffIt File", 0)
  1362.     » true (moves the first item of "Old StuffIt File" to the root of "New StuffIt File")
  1363. See Also    StuffIt.copyItem
  1364.  
  1365. Verb    StuffIt.newArchive
  1366. Syntax    StuffIt.newArchive (path, is151)
  1367. Parameters    path: the full path of the location where you want to put this archive
  1368. is151: true or false, determines if the new archive will be a StuffIt 1.5.1 document
  1369. Action    Makes a new archive at the place you specify. You can make it either a StuffIt Deluxe document or a StuffIt 1.5.1 document
  1370. Returns    0 if there was no error
  1371. a negative number indicates an operating System error
  1372. 2 if there are already too many archives open
  1373. Examples    StuffIt.newArchive ("My HD:My Folder:My StuffIt File",false)
  1374. » true (makes a new StuffIt archive named "My StuffIt File")
  1375. Notes    Remember that StuffIt 1.5.1 documents can not be manipulated by many of these verbs. Check each verb specifically.
  1376. This verb will overwrite a file with the same pathname. So if a file already exists with the same name at the location you specify, it will be erased.
  1377. See Also    StuffIt.openArchive
  1378. StuffIt.archive.getMaxCount
  1379. StuffIt.archive.close
  1380.  
  1381. Verb    StuffIt.newFolder
  1382. Syntax    StuffIt.newFolder (name)
  1383. Parameters    name: the name of the folder you wish to create
  1384. Action    Makes a new folder, with the name you specify, on the current level of the current archive.
  1385. Returns    true if the folder was successfully made
  1386. Examples    StuffIt.newFolder ("Cool Things folder")
  1387.     » true (makes a new folder in the current level named "Cool Things folder")
  1388. See Also    StuffIt.openFolder
  1389. StuffIt.getCurrentFolder
  1390.  
  1391. Verb    StuffIt.openArchive
  1392. Syntax    StuffIt.openArchive (path)
  1393. Parameters    path: the pathname of the archive you wish to open
  1394. Action    StuffIt will attempt to open the archive you specify
  1395. Returns    true if the archive was successfully opened
  1396. Examples    StuffIt.openArchive ("My HD:My Folder:My StuffIt File")
  1397.     » true (opens My StuffIt File)
  1398. Notes    When you open an archive, it will become the current archive (index 0). If you open an archive which is already open, StuffIt will still return true.
  1399. This has the same function as required.openDocument(path)
  1400. See Also    StuffIt.archive.getMaxCount
  1401. StuffIt.newArchive
  1402. StuffIt.closeArchive
  1403.  
  1404. Verb    StuffIt.openFolder
  1405. Syntax    StuffIt.openFolder (ID)
  1406. Parameters    ID: the offset which contains the information for this item. This number is based on a propietary numbering scheme of StuffIt.
  1407. Action    Opens the folder at the ID you specify and makes it the current level
  1408. Returns    0 if there was no error
  1409. -1 if no archive is open
  1410. -2 if the offset you specify is out of range
  1411. -3 if the item is not a folder
  1412. -4 if the frontmost archive is a StuffIt 1.5.1 document
  1413. Examples    StuffIt.openFolder (StuffIt.getFirstItem())
  1414.     » 0 (opens the first item (which is a folder))
  1415. StuffIt.openFolder (StuffIt.getFirstItem())
  1416.     »-3 (the first item is not a folder)
  1417. See Also    StuffIt.isFolder
  1418. StuffIt.getItemKind
  1419. StuffIt.newFolder
  1420. StuffIt.getCurrentFolder
  1421.  
  1422. Verb    StuffIt.outlineArchive
  1423. Syntax    StuffIt.outlineArchive (pathname,outlineAddress,details)
  1424. Parameters    pathname: the full path of the archive you wish to outline
  1425. outlineAddress: the address in the Frontier Database where you want to place the outline
  1426. details: true or false. True if you want to include information such as size, type, creator, and modified date, for each file.
  1427. Action    Outlines the archive you specify
  1428. Returns    true if there was no error
  1429. Examples    StuffIt.outlineArchive ("My HD:My Folder:My StuffItFile",@people.[user.initials].archiveoutline,true)
  1430.     » true (outline was successfully made for the archive My StuffItFile. For an example, look at StuffIt.ArchiveOutline)
  1431.  
  1432. Verb    StuffIt.password.isSet
  1433. Syntax    StuffIt.password.isSet ()
  1434. Parameters    None
  1435. Action    returns true is the current archive has a password assigned to it
  1436. Returns    true if there is a password on the archive
  1437. Examples    StuffIt.password.isSet ()
  1438.     » true
  1439. See Also    StuffIt.encryptItem
  1440. StuffIt.password.set
  1441.  
  1442. Verb    StuffIt.password.set
  1443. Syntax    StuffIt.password.set (password)
  1444. Parameters    password: the password you wish to use for stuffing or unstuffing items
  1445. Action    assigns password to the current archive in order to encrypt files as they are stuffed
  1446. Returns    true if the password was accepted
  1447. false will be returned if the password already has an archive
  1448. Examples    StuffIt.password.set ("secret")
  1449.     » true
  1450. See Also    StuffIt.encryptItem
  1451. StuffIt.password.isSet
  1452.  
  1453. Verb    StuffIt.paste
  1454. Syntax    StuffIt.paste ()
  1455. Parameters    None
  1456. Action    Pastes the contents of the clipboard into the frontmost archive
  1457. Just like choosing "Paste" from StuffIt's Edit Menu
  1458. Returns    true if no error occured while pasting the selected item(s)
  1459. false if the contents of the clipboard are not "pastable"
  1460. Examples    StuffIt.paste ()
  1461.     »true
  1462. See Also    StuffIt.clear
  1463. StuffIt.copy
  1464.  
  1465. Verb    StuffIt.quit
  1466. Syntax    StuffIt.quit ()
  1467. Parameters    None
  1468. Action    Quits StuffIt Deluxe
  1469. Returns    true if there was no error
  1470. Examples    StuffIt.quit ()
  1471.     » true (quits StuffIt Deluxe)
  1472. Notes    this verb uses required.quitApplication
  1473. See Also    StuffIt.launch
  1474. StuffIt.isRunning
  1475.  
  1476. Verb    StuffIt.renameItem
  1477. Syntax    StuffIt.renameItem (ID,newName)
  1478. Parameters    ID: The offset in the archive of the item you wish to rename. 
  1479. newName: the new name of the item you specified
  1480. Action    Renames the item at the ID you specify.
  1481. Returns    0 if there was no error
  1482. -1 if no archive is open
  1483. -2 if the index you specify is out of range
  1484. -3 if the offset you specify cannot be renamed (i.e., is an end-of-folder)
  1485. -4 if the current archive is a StuffIt 1.5.1 document
  1486. Examples    StuffIt.renameItem (StuffIt.getFirstItem(),"Cool Things 2")
  1487.     » 0 (renames the first item in the archive to Cool Things 2)
  1488. See Also    StuffIt.getItemName
  1489. StuffIt.selection.rename
  1490.  
  1491. Verb    StuffIt.saveAs
  1492. Syntax    StuffIt.saveAs (path)
  1493. Parameters    path: the full pathname of the location where you would like to save the archive
  1494. Action    Saves a copy of the current archive at the location you specify
  1495. Returns    true if there was no error
  1496. -1 if no archive was open
  1497. Examples    StuffIt.saveAs ("My HD:My Folder:My Backup")
  1498.     » true (saves a copy of this archive as My Backup)
  1499. Notes    This verb will not overwrite a pre-existing file with the same name.
  1500.  
  1501. Verb    StuffIt.sea.attach
  1502. Syntax    StuffIt.sea.attach ()
  1503. Parameters    None
  1504. Action    Makes the frontmost archive into a self-extracting archive (SEA)
  1505. Returns    true if there was no error
  1506. -1 if no archive was open
  1507. Examples    StuffIt.sea.attach ()
  1508.     » true (the frontmost archive is now a self-extracting archive)
  1509. See Also    StuffIt.sea.isSEA
  1510. StuffIt.sea.remove
  1511.  
  1512. Verb    StuffIt.sea.isSEA
  1513. Syntax    StuffIt.sea.isSEA ()
  1514. Parameters    None
  1515. Action    Determines whether or not the frontmost archive is self-extracting
  1516. Returns    true if the current archive is a self-unstuffing archive
  1517. -1 if no archive was open
  1518. Examples    StuffIt.sea.isSEA ()
  1519.     » false (The frontmost archive is not a self-unstuffer)
  1520. See Also    StuffIt.sea.attach
  1521. StuffIt.sea.remove
  1522.  
  1523. Verb    StuffIt.sea.remove
  1524. Syntax    StuffIt.sea.remove ()
  1525. Parameters    None
  1526. Action    Removes the self-extracting code from an archive
  1527. Returns    true if there was no error
  1528. -1 if no archive was open
  1529. Examples    StuffIt.sea.remove ()
  1530.     » true (This archive is no longer self-extracting)
  1531. Notes    This verb will return true even if the file is not self-extracting.
  1532. See Also    StuffIt.sea.attach
  1533. StuffIt.sea.isSEA
  1534.  
  1535. Verb    StuffIt.sea.saveAsSEA
  1536. Syntax    StuffIt.sea.saveAsSEA (path)
  1537. Parameters    path: the full pathname of the destination for your new archive
  1538. Action    Creates a copy of the current archive, and then saves it as self-extracting in the location you specify
  1539. Returns    true if there was no error
  1540. -1 if no archive was open
  1541. Examples    StuffIt.sea.saveAsSEA ("My HD:My Folder:My Backup")
  1542.     » true (the current archive was saved as My Backup and made into a self-extracting archive)
  1543. Notes    This verb will not overwrite any pre-existing file with the same name
  1544.  
  1545. Verb    StuffIt.segmenting.join
  1546. Syntax    StuffIt.segmenting.join (pathname, replace, prompt)
  1547. Parameters    pathname: the filenames of the items you wish to join (wildcards are accepted)
  1548. replace: true or false. Determines whether or not to replace items with the same name
  1549. prompt: true or false. Determines whether or not to notify user of collision errors or name conflicts
  1550. Action    Joins the files you specify into one file
  1551. Returns    true if the files were joined, false if they were not
  1552. Examples    StuffIt.segmenting.join ("My HD:My Folder:My segments",true,false)
  1553.     » true (the files were joined, and any items with the same name were replaced)
  1554. See Also    StuffIt.segmenting.segment
  1555. StuffIt.segmenting.segmentInPlace
  1556. StuffIt.segmenting.segmentInPlaceWithSize
  1557. StuffIt.segmenting.joinInPlace
  1558.  
  1559. Verb    StuffIt.segmenting.joinInPlace
  1560. Syntax    StuffIt.segmenting.joinInPlace (pathname)
  1561. Parameters    pathname: the filenames of the items you wish to join (wildcards are accepted)
  1562. Action    Joins the files you specify into one file
  1563. Returns    true if the files were joined, false if they were not
  1564. Examples    StuffIt.segmenting.joinInPlace ("My HD:My Folder:My segments")
  1565.     » true (the files were joined)
  1566. Notes    This verb differs from join in that you cannot specify how to deal with potential problems. In join you can specify whether or not to replace files with the same name or to notify the user if a problem shows up.
  1567. With this verb, these two parameters default to false. No files will get overwritten and the user will not be alerted should an error arise
  1568. See Also    StuffIt.segmenting.segment
  1569. StuffIt.segmenting.segmentInPlace
  1570. StuffIt.segmenting.segmentInPlaceWithSize
  1571. StuffIt.segmenting.join
  1572.  
  1573. Verb    StuffIt.segmenting.segment
  1574. Syntax    StuffIt.segmenting.segment (pathname, replace, prompt, size)
  1575. Parameters    pathname: the pathnames of the files you wish to segment (Wild cards may be used)
  1576. replace: true or false, whether or not to replace any files which have the same names
  1577. prompt: true or false, whether or not to prompt the user should there be any problems
  1578. size: the number of K you wish each segment to be (0 is maximum)
  1579. Action    Segments the files you specify into fragments of sizes which you specify
  1580. Returns    true or false, depending on the success
  1581. Examples    StuffIt.segment ("My HD:My Folder:My Files",true,false,800)
  1582.     »true (My Files were segmented, replacing any files which had the same name, into blocks of 800 K each)
  1583. See Also    StuffIt.segmenting.join
  1584. StuffIt.segmenting.joinInPlace
  1585. StuffIt.segmenting.segmentInPlace
  1586. StuffIt.segmenting.segmentInPlacewithsize
  1587.  
  1588. Verb    StuffIt.segmenting.segmentInPlace
  1589. Syntax    StuffIt.segmenting.segmentInPlace (pathname)
  1590. Parameters    pathname: the pathnames of the files you wish to segment (Wild cards may be used)
  1591. Action    Segments the files you specify, without replacing any files and without prompting you if there is an error
  1592. Returns    true or false, depending on the success of the segmenting
  1593. Examples    StuffIt.segmenting.segmentInPlace ("My HD:My Folder:My Files")
  1594.     »true (My Files were segmented)
  1595. Notes    This verb is different from segment in that you have more control with segment. With this verb, all the parameters revert to their defaults
  1596. The default of whether or not to replace files with the same name is false, as is the default of whether or not to prompt the user when an error occurs.
  1597. The default size is set at the user's default, which is set within StuffIt. If no default has been set, StuffIt uses the last size which was used.
  1598. See Also    StuffIt.segmenting.join
  1599. StuffIt.segmenting.joinInPlace
  1600. StuffIt.segmenting.segment
  1601. StuffIt.segmenting.segmentInPlacewithsize
  1602.  
  1603. Verb    StuffIt.segmenting.segmentInPlaceWithSize
  1604. Syntax    StuffIt.segmenting.segmentInPlaceWithSize (pathname, size)
  1605. Parameters    pathname: the pathnames of the files you wish to segment (Wild cards may be used)
  1606. size: the maximum size (in K) you wish each segment to be
  1607. Action    Segments the files you specify into segments, without replacing any files and without prompting you if there is an error, but allowing you to specify a size
  1608. Returns    true or false, depending on the success of the segmenting
  1609. Examples    StuffIt.segmenting.segmentInPlaceWithSize ("My HD:My Folder:My Files",800)
  1610.     »true (My Files were segmented into 800K files)
  1611. Notes    This verb is different from segment in that you have more control with segment. With this verb, most of the optional parameters revert to their defaults
  1612. The default of whether or not to replace files with the same name is false, as is the default of whether or not to prompt the user when an error occurs.
  1613. See Also    StuffIt.segmenting.join
  1614. StuffIt.segmenting.joinInPlace
  1615. StuffIt.segmenting.segment
  1616. StuffIt.segmenting.segmentInPlace
  1617.  
  1618. Verb    StuffIt.selection.addAll
  1619. Syntax    StuffIt.selection.addAll ()
  1620. Parameters    None
  1621. Action    Selects all the items in the current level of the current archive
  1622. Returns    0 if there was no error
  1623. -1 if no archive is open
  1624. Examples    StuffIt.selection.addAll ()
  1625.     » 0 (all the items on the current level are now hilited)
  1626. See Also    StuffIt.selection.clearAll
  1627.  
  1628. Verb    StuffIt.selection.addbyPattern
  1629. Syntax    StuffIt.selection.addbyPattern (pattern)
  1630. Parameters    pattern: the text which StuffIt uses to select names.  Usually this is a wildcard specifier.
  1631. Action    Selects all the items in the current level of the current archive whose names include pattern
  1632. Returns    0 if there was no error
  1633. -1 if no archive is open
  1634. Examples    StuffIt.selection.addByPattern ("Ki*")
  1635.     » 0 (all the items on the current level which start with Ki are now hilited)
  1636. Notes    Wild card characters may be used. They are as follows:
  1637. ? = matches any letter
  1638. * = matches one or more letters
  1639. \* = * (the real character, not the code)
  1640. \? = ? (the real character, not the code)
  1641. \\=\ (the real character, not the code)
  1642. So, to select all files which begin with Te and end with xt, you would use Te*xt
  1643. See Also    StuffIt.selection.AddTo
  1644. StuffIt.selection.removeFrom
  1645. StuffIt.selection.addAll
  1646. StuffIt.selection.clearAll
  1647.  
  1648. Verb    StuffIt.selection.addTo
  1649. Syntax    StuffIt.selection.addTo (ID)
  1650. Parameters    ID: The offset in the archive of the item you wish to rename. This offset is based on a propietary numbering scheme in StuffIt, so there's no way to set it.
  1651. Action    Adds the item you specify to the current selection
  1652. Returns    0 if there was no error
  1653. -1 if no archive is open
  1654. Examples    StuffIt.selection.addTo (StuffIt.getFirstItem())
  1655.     » 0 (the first item in the archive was added to the selection)
  1656. See Also    StuffIt.selection.addAll
  1657. StuffIt.selection.clearAll
  1658. StuffIt.selection.removeFrom
  1659.  
  1660. Verb    StuffIt.selection.clearAll
  1661. Syntax    StuffIt.selection.clearAll ()
  1662. Parameters    None
  1663. Action    Unselects all the items in the current level of the current archive
  1664. Returns    0 if there was no error
  1665. -1 if no archive is open
  1666. Examples    StuffIt.selection.clearAll ()
  1667.     » 0 (none of the items on the current level are now hilited)
  1668. See Also    StuffIt.selection.addAll
  1669. StuffIt.selection.removeFrom
  1670. StuffIt.selection.addTo
  1671. StuffIt.selection.addbyPattern
  1672.  
  1673. Verb    StuffIt.selection.delete
  1674. Syntax    StuffIt.selection.delete ()
  1675. Parameters    None
  1676. Action    Deletes the selection, without a warning dialog box
  1677. Returns    0 if there was no error
  1678. -1 if no archive is open
  1679. -8 if the archive is read-only
  1680. Examples    StuffIt.selection.delete ()
  1681.     » 0 (all the items that were selected have been deleted)
  1682. See Also    StuffIt.selection.addAll
  1683. StuffIt.selection.addTo
  1684. StuffIt.selection.addByPattern
  1685. StuffIt.selection.removeFrom
  1686.  
  1687. Verb    StuffIt.selection.getCount
  1688. Syntax    StuffIt.selection.getCount ()
  1689. Parameters    None
  1690. Action    Returns the number of items which are selected
  1691. Returns    the number of selected items
  1692. -1 if no archive is open
  1693. Examples    StuffIt.selection.getCount ()
  1694.     » 3 (three items are selected on the current level)
  1695. See Also    StuffIt.selection.addAll
  1696. StuffIt.selection.clearAll
  1697. StuffIt.selection.removeFrom
  1698. StuffIt.selection.addTo
  1699. StuffIt.selection.addbyPattern
  1700.  
  1701. Verb    StuffIt.selection.getID
  1702. Syntax    StuffIt.selection.getID (index)
  1703. Parameters    index: a number, from 1 on, which represents the item within the selection whose offset you want.
  1704. For example, the second selected item would have an index of 2
  1705. Action    Returns the offset of the item you specify with index
  1706. Returns    the offset of the specified item
  1707. -1 if no archive is open
  1708. -2 if the index you used is out of range
  1709. Examples    StuffIt.selection.getID (1)
  1710.     » 22 (the offset of the first selected item)
  1711. See Also    StuffIt.selection.addAll
  1712. StuffIt.selection.clearAll
  1713. StuffIt.selection.removeFrom
  1714. StuffIt.selection.addTo
  1715. StuffIt.selection.addbyPattern
  1716.  
  1717. Verb    StuffIt.selection.removeFrom
  1718. Syntax    StuffIt.selection.removeFrom (ID)
  1719. Parameters    ID: The offset of the file information within the archive. Based on a propietary numbering scheme used by StuffIt Deluxe.
  1720. Action    Removes the item you specify from the selection
  1721. Returns    0 if no error occurred
  1722. 1 if the item you specified is not at the current level
  1723. -1 if no archive is open
  1724. -2 if the offset you used is out of range
  1725. -5 if you specified an end-of-folder marker
  1726. -6 if you specified the root of the archive (0)
  1727. Examples    StuffIt.selection.removeFrom (StuffIt.selection.getID(1))
  1728.     » 0 (the first selected item was de-selected)
  1729. See Also    StuffIt.selection.addAll
  1730. StuffIt.selection.clearAll
  1731. StuffIt.selection.addTo
  1732. StuffIt.selection.addbyPattern
  1733. StuffIt.selection.getID
  1734.  
  1735. Verb    StuffIt.selection.rename
  1736. Syntax    StuffIt.selection.rename (newName)
  1737. Parameters    newName: the new name you would like to assign to the selections
  1738. Action    Renames all the selected items to newName
  1739. Returns    0 if no error occurred
  1740. -1 if no archive is open
  1741. -2 if no files were selected
  1742. -8 if current archive is read-only
  1743. Examples    StuffIt.selection.rename ("Cool Things")
  1744.     » 0 (all the selected items were renamed to Cool Things)
  1745. See Also    StuffIt.selection.addAll
  1746. StuffIt.selection.clearAll
  1747. StuffIt.selection.removeFrom
  1748. StuffIt.selection.addTo
  1749. StuffIt.selection.addbyPattern
  1750.  
  1751. Verb    StuffIt.selection.unStuff
  1752. Syntax    StuffIt.selection.unStuff (path)
  1753. Parameters    path - full pathname to the location you want the selected items unstuffed to
  1754. Action    UnStuffs all the selected items
  1755. Returns    0 if there was no error
  1756. -1 if no archive is open
  1757. Other negative numbers are OS errors
  1758. Examples    StuffIt.selection.unStuff ("My HD:")
  1759.     » 0 (all selected items are unstuffed to the root of my hard disk)
  1760. See Also    StuffIt.unStuffItem
  1761. StuffIt.unStuffInPlace
  1762. StuffIt.selection.addAll
  1763. StuffIt.selection.removeFrom
  1764. StuffIt.selection.addTo
  1765. StuffIt.selection.addbyPattern
  1766.  
  1767. Verb    StuffIt.selection.view
  1768. Syntax    StuffIt.selection.view ()
  1769. Parameters    None
  1770. Action    Views all the selected items
  1771. Returns    0 if no error occurred
  1772. -1 if no archive is open
  1773. -2 if no files were selected
  1774. Examples    StuffIt.selection.view ()
  1775.     » 0 (all TEXT and PICT files have been opened for me to view)
  1776. Notes    This verb is only available for StuffIt Deluxe, since StuffIt Lite does not support Viewers.
  1777. See Also    StuffIt.selection.addAll
  1778. StuffIt.selection.clearAll
  1779. StuffIt.selection.removeFrom
  1780. StuffIt.selection.addTo
  1781. StuffIt.selection.addbyPattern
  1782.  
  1783. Verb    StuffIt.setArchiveView
  1784. Syntax    StuffIt.setArchiveView (path, name)
  1785. Parameters    path: the full pathname of the archive you wish to make the current archive
  1786. name: the name of the view to change to
  1787. Action    Changes the viewing method of the archive you specify
  1788. Returns    0 if there was no error
  1789. -1 if no such archive is open
  1790. Examples    StuffIt.setArchiveView ("My HD:My Folder:My StuffIt File", "by Name")
  1791.     » 0 (My StuffIt File was open and is now viewing by Name)
  1792. See Also    StuffIt.getArchiveView
  1793.  
  1794. Verb    StuffIt.setCurrentArchive
  1795. Syntax    StuffIt.setCurrentArchive (path)
  1796. Parameters    path: the full pathname of the archive you wish to make the current archive
  1797. Action    Brings the archive you specify to the front, making it the current archive
  1798. Returns    0 if there was no error
  1799. -1 if no such archive is open
  1800. Examples    StuffIt.setCurrentArchive ("My HD:My Folder:My StuffIt File")
  1801.     » 0 (My StuffIt File was open and is now the current archive)
  1802. See Also    StuffIt.openArchive
  1803. StuffIt.closeArchive
  1804. StuffIt.getCurrentArchivePath
  1805.  
  1806. Verb    StuffIt.setItemLabel
  1807. Syntax    StuffIt.setItemLabel (ID, name)
  1808. Parameters    ID: The offset in the archive of the item you wish to label.
  1809. name: the name of the label you wish to use
  1810. Action    Changes the label of the item at the ID you specify.
  1811. Returns    0 if there was no error
  1812. -1 if no archive is open
  1813. -2 if the index you specify is out of range
  1814. Examples    StuffIt.setItemLabel (StuffIt.getFirstItem(),"Cool")
  1815.     » 0 (changes the label of the first item in the archive to Cool)
  1816. See Also    StuffIt.getItemLabel
  1817.  
  1818. Verb    StuffIt.stackWindows
  1819. Syntax    StuffIt.stackWindows ()
  1820. Parameters    None
  1821. Action    Stacks all currently open windows
  1822. Just like choosing "Stack Windows" from StuffIt's Windows Menu
  1823. Returns    true if no error occured while stacking the windows
  1824. Examples    StuffIt.stackWindows ()
  1825.     »true
  1826. See Also    StuffIt.tileWindows
  1827.  
  1828. Verb    StuffIt.stuffInPlace
  1829. Syntax    StuffIt.stuffInPlace (path)
  1830. Parameters    path: the pathname of the file or folder you'd like to stuff 
  1831. Action    Takes the folder/file you specify and stuffs in into a new archive at the same location.
  1832. Returns    0 if there was no error
  1833. Other negative numbers are OS Errors
  1834. Examples    StuffIt.stuffInPlace ("My HD:My Folder:My File")
  1835.     »0 (My File was stuffed into "My File.sit" in "My HD:My Folder:")
  1836. See Also    StuffIt.unstuffInPlace
  1837. StuffIt.stuffItem
  1838.  
  1839. Verb    StuffIt.stuffItem
  1840. Syntax    StuffIt.stuffItem (path)
  1841. Parameters    path: the pathname of the file or folder you'd like to stuff  into the current archive
  1842. Action    Takes the folder/file you specify and adds it to the current level of the frontmost archive.
  1843. Returns    0 if there was no error
  1844. -1 if no archive is currently open
  1845. -7 if there are already too many items in the archive
  1846. -8 if the frontmost archive is read-only
  1847. Examples    StuffIt.stuffItem ("My HD:My Folder:My File")
  1848.     »0 (My File was added to the current level of the archive)
  1849. See Also    StuffIt.encryptItem
  1850. StuffIt.stuffInPlace
  1851. StuffIt.unstuffItem
  1852.  
  1853. Verb    StuffIt.tileWindows
  1854. Syntax    StuffIt.tileWindows ()
  1855. Parameters    None
  1856. Action    Tiles all currently open windows
  1857. Just like choosing "Tile Windows" from StuffIt's Windows Menu
  1858. Returns    true if no error occured while tiling the windows
  1859. Examples    StuffIt.tileWindows ()
  1860.     »true
  1861. See Also    StuffIt.stackWindows
  1862.  
  1863. Verb    StuffIt.translate.decode
  1864. Syntax    StuffIt.translate.decode (translator,pathname)
  1865. Parameters    translator: the translator you wish to use
  1866. pathname: the file you wish to translate
  1867. Action    Translates the file you specify with the translator of your choice
  1868. Returns    true or false, depending on the success of the translation
  1869. Examples    StuffIt.translate.decode ("CompactPro Translator","My HD:My Folder:My CompactPro document")
  1870.     »true (my CompactPro documents were successfully translated)
  1871. Notes    Remember that translators are kept in the Translators folder, in the Aladdin Folder, in the Extensions Folder
  1872. The decoded/expanded file is put at the same level as the original.
  1873. See Also    StuffIt.translate.decodeTo
  1874. StuffIt.translate.encode
  1875. StuffIt.translate.encodeTo
  1876.  
  1877. Verb    StuffIt.translate.decodeTo
  1878. Syntax    StuffIt.translate.decodeTo (translator,sourcePath,destPath)
  1879. Parameters    translator: the translator you wish to use
  1880. sourcePath: the pathname of the file you wish to translate
  1881. destPath: the pathname where you want the translated file
  1882. Action    Translates the file you specify with the translator of your choice, and to the place you specify
  1883. Returns    true or false, depending on the success of the translation
  1884. Examples    StuffIt.translate.decodeTo ("CompactPro Translator","My HD:My Folder:My CompactPro document","My HD:My Folder:My Expanded Files")
  1885.     »true (my CompactPro documents were successfully translated to My Expanded Files)
  1886. Notes    Remember that translators are kept in the Translators folder, in the Aladdin Folder, in the Extensions Folder
  1887. See Also    StuffIt.translate.decode
  1888. StuffIt.translate.encode
  1889. StuffIt.translate.encodeTo
  1890.  
  1891. Verb    StuffIt.translate.encode
  1892. Syntax    StuffIt.translate.encode (translator,sourcePath)
  1893. Parameters    translator: the translator you wish to use
  1894. sourcePath: the pathname of the file you wish to encode with a translator
  1895. Action    Translates the StuffIt archive you specify into the format you specify.
  1896. Returns    true or false, depending on the success of the translation
  1897. Examples    StuffIt.translate.encode ("BinHex4","My HD:My Folder:My File")
  1898.     »true (the file was translated into a BinHex4 document)
  1899. Notes    Remember that translators are kept in the Translators folder, in the Aladdin Folder, in the Extensions Folder
  1900. The new file will be placed in the same location as the original.
  1901. See Also    StuffIt.translate.decode
  1902. StuffIt.translate.decodeTo
  1903. StuffIt.translate.encodeTo
  1904.  
  1905. Verb    StuffIt.translate.encodeTo
  1906. Syntax    StuffIt.translate.encodeTo (translator,sourcePath,destPath)
  1907. Parameters    translator: the translator you wish to use
  1908. sourcePath: the pathname of the file you wish to translate
  1909. destPath: the pathname where you want to place the translated file
  1910. Action    Encodes the file you specify with the translator of your choice, and to the place you specify
  1911. Returns    true or false, depending on the success of the encoding
  1912. Examples    StuffIt.translate.encodeTo ("BinHex4","My HD:My Folder:My File","My HD:My Folder:My BinHex document")
  1913.     »true (the archive were successfully translated into BinHex4 documents)
  1914. Notes    Remember that translators are kept in the Translators folder, in the Aladdin Folder, in the Extensions Folder
  1915. See Also    StuffIt.translate.decode
  1916. StuffIt.translate.decodeTo
  1917. StuffIt.translate.encode
  1918.  
  1919. Verb    StuffIt.translate.translate
  1920. Syntax    StuffIt.translate (translator,script)
  1921. Parameters    translator: the translator you wish to use
  1922. script: the translator script you wish processed
  1923. Action    Translates the file you specify with the translator of your choice
  1924. Returns    true or false, depending on the success of the translation
  1925. Examples    StuffIt.translate ("CompactPro Translator","Decode “My HD:My Folder:My CompactPro document”")
  1926.     »true (my CompactPro documents were successfully translated)
  1927. Notes    This is a "low level" verb, and should be used only if you need greater control or flexibility.
  1928. Remember that translators are kept in the Translators folder, in the Aladdin Folder, in the Extensions Folder
  1929. See Also    StuffIt.translate.decode
  1930. StuffIt.translate.decodeTo
  1931. StuffIt.translate.encode
  1932. StuffIt.translate.encodeTo
  1933.  
  1934. Verb    StuffIt.unStuffInPlace
  1935. Syntax    StuffIt.unStuffInPlace (path)
  1936. Parameters    path: the full pathname of the archive you wished unstuffed
  1937. Action    Unstuffs the contents of the archive into the same folder as the archive
  1938. Returns    0 if there was no error
  1939. Other negative numbers are OS errors
  1940. Examples    StuffIt.unStuffInPlace ("My HD:My Folder:My Archive.sit")
  1941.     » 0 (Unstuffs "My Archive.sit" into "My HD:My Folder")
  1942. See Also    Stuffit.unStuffItem
  1943. StuffIt.stuffInPlace
  1944. StuffIt.stuffItem
  1945.  
  1946. Verb    StuffIt.unStuffItem
  1947. Syntax    StuffIt.unStuffItem (ID,path)
  1948. Parameters    ID: The offset in the archive of the item you wish to rename. This offset is based on a propietary numbering scheme in StuffIt, so there's no way to set it.
  1949. path: the full pathname of the destination for the unstuffed files
  1950. Action    Unstuffs the item you specify into the pathname you specify
  1951. Returns    0 if there was no error
  1952. -1 if no archive is open
  1953. -2 if the offset you specify is out of range
  1954. -5 if the offset you specified is an end-of-folder
  1955. Other negative numbers are OS errors
  1956. Examples    StuffIt.unStuffItem (StuffIt.getFirstItem(), "My HD:My Folder:My Unstuffed File")
  1957.     » 0 (Unstuffs the first item in the archive to My Unstuffed File)
  1958. See Also    StuffIt.stuffItem
  1959. StuffIt.unStuffInPlace
  1960. StuffIt.stuffInPlace
  1961.  
  1962. Verb    StuffIt.verifyArchive
  1963. Syntax    StuffIt.verifyArchive ()
  1964. Parameters    None
  1965. Action    Verifies the frontmost archive
  1966. Returns    true if the archive was successfully verified
  1967. Examples    StuffIt.verifyArchive ()
  1968.     »true (the archive was verified successfully)
  1969. Notes    Since the verb returns only true or false, you will need to check the situation if you get false. For instance, this may mean that the archive is corrupted, or it may mean that no archive is currently open.
  1970.  
  1971. Verb    StuffIt.visitArchive
  1972. Syntax    StuffIt.visitArchive (levels,callback)
  1973. Parameters    levels: the amount of levels down in the archive you wish to go
  1974. callback: the script you want performed at each item in the archive
  1975. Action    "Visits" the frontmost archive. This verb is very similar to the visit object verbs in Frontier. You specify how many levels down you wish the script to go. At each item in those levels, the callback script will be executed. 
  1976. Returns    varies on what you've set your callback script to do
  1977. Examples    StuffIt.visitArchive (2, people.dfs.utilityScripts.StuffItCallBackScript ())
  1978.     »results may vary (if your callback script returns a value, for instance)
  1979.